Get all responses for a survey.

Required permissions: Responses and Reporting

get

Path parameters

surveyIDstring · uuidRequired

Query parameters

numRecordsinteger · int32Optional

startIndexinteger · int32Optional

includePartialbooleanOptional

startDatestringOptional

endDatestringOptional

apiTokenstringRequired

API authentication token

Responses

200

OK

application/json

surveyIDstringOptional

responseCountinteger · int32Optional

400

Missing Parameter Value

application/json

401

Incorrect Permissions or Invalid API Token

application/json

500

Engage Server Error. Unable to process response at this time.

application/json

get/surveys/{surveyID}/responses

GET /surveys/{surveyID}/responses?apiToken=text HTTP/1.1
Host: api.ubiquity.co.nz
Accept: */*

{
  "surveyID": "text",
  "responseCount": 1,
  "responses": [
    {
      "responseID": "text",
      "data": [
        {
          "fieldID": "text",
          "name": "text",
          "value": "text"
        }
      ],
      "meta": [
        {
          "fieldID": "text",
          "name": "text",
          "value": "text"
        }
      ],
      "answers": [
        {
          "fieldID": "text",
          "name": "text",
          "value": "text"
        }
      ]
    }
  ]
}