Retrieve Response Response

result objectrequired

responseIdresponseId (string)required

The unique ID for each response

values objectrequired

values is a set of key-value pairs corresponding to question-answer pairs. There can also be key-value pairs representing meta data for the response such as startDate or userLanguage.

distributionChanneldistributionChannel (string)

The method by which the survey was distributed to respondents

durationduration (integer)

How long it took for the respondent to finish the survey in seconds

endDatestring<date-time>required

The point in time when the survey response was finished

finishedfinished (integer)required

If the respondent finished and submitted the survey, the value will be 1, otherwise it will be 0

locationLatitudelocationLatitude (string)

The approximate location of the respondent at the time the survey was taken

locationLongitudelocationLongitude (string)

The approximate location of the respondent at the time the survey was taken

progressprogress (integer)

How far the respondent has progressed through the survey as a percentage

recordedDatestring<date-time>required

The point in time when the survey response was recorded

startDatestring<date-time>required

The point in time when the survey response was started

statusstatus (integer)required

The type of response

userLanguageuserLanguage (string)

The language of the respondent

property name*any

values is a set of key-value pairs corresponding to question-answer pairs. There can also be key-value pairs representing meta data for the response such as startDate or userLanguage.

labels objectrequired

labels is a set of key-value pairs where each key corresponds to a key in the values object and the value is the label of the answer of that question.

property name*any

labels is a set of key-value pairs where each key corresponds to a key in the values object and the value is the label of the answer of that question.

displayedFieldsstring[]

All the fields that were displayed during the taking of the survey

displayedValues object

For every field, the values that were displayed during the taking of the survey

property name*any

For every field, the values that were displayed during the taking of the survey

meta objectrequired

httpStatushttpStatus (string)required

HTTP status code

requestIdrequestId (string)required

An identifier for the incoming request.

noticeAn informational string about the request. (string)

Retrieve Response Response

{
  "result": {
    "responseId": "string",
    "values": {
      "distributionChannel": "string",
      "duration": 0,
      "endDate": "2024-07-29T15:51:28.071Z",
      "finished": 0,
      "locationLatitude": "string",
      "locationLongitude": "string",
      "progress": 0,
      "recordedDate": "2024-07-29T15:51:28.071Z",
      "startDate": "2024-07-29T15:51:28.071Z",
      "status": 0,
      "userLanguage": "string"
    },
    "labels": {},
    "displayedFields": [
      "string"
    ],
    "displayedValues": {}
  },
  "meta": {
    "httpStatus": "string",
    "requestId": "string",
    "notice": "string"
  }
}