List survey responses

Authorization

BearerAuth

AuthorizationBearer <token>

In: header

Path Parameters

studyKey*string

Query Parameters

surveyKey*string

shortKeys?boolean

whether to return short keys for responses

Defaultfalse

questionOptionSep?string

character used to seperate question options in response

Default"-"

format?string

format for survey responses

Default"wide"

Value in"wide" | "long" | "json"

page?integer

page number (starting from 1)

Default1

Range1 <= value

limit?integer

maximum number of responses per page

Default10

Range1 <= value

filter?

bson.M object to filter responses

sort?

bson.M object to sort responses

extraContextColumns?string

comma-separated list of extra context columns to include in the response

Response Body

`application/json`

curl -X GET "https://example.com/v1/studies/string/data-explorer/responses/?surveyKey=string"

{
  "responses": [
    {
      "property1": {},
      "property2": {}
    }
  ],
  "pagination": {
    "totalCount": 0,
    "currentPage": 0,
    "totalPages": 0,
    "pageSize": 0
  }
}

{
  "error": "string"
}

{
  "error": "string"
}

{
  "error": "string"
}

List survey responses

Authorization

Path Parameters

Query Parameters

Response Body

200application/json

400application/json

401application/json

500application/json

`application/json`

`application/json`

`application/json`

`application/json`