Get all responses

GET 
/v3/responses

Get all responses

Request

Query Parameters

limit number

Possible values: >= 1 and <= 1000

Default value: 50

survey_id numberrequired
contact_id number
contacts object

Filter using contact properties. Custom contact properties are not supported. Encode parameters when using special characters.

variables object

Filter using custom variables. Encode parameters when using special characters. Provide the date values in either MM-DD-YYYY or YYYY-MM-DD format.

page number

Possible values: >= 1

date.gte date
date.lte date
created_date.gte date
created_date.lte date
state string

Possible values: [started, completed, all]

order_by string

Possible values: [startTime, id, completedTime]

Default value: completedTime

order string

Possible values: [ASC, DESC]

Default value: DESC

preserve_format boolean

Responses

200

Successful

*/*

Schema

Schema

has_next_page boolean

data

object[]

Array [

id number

Id of response

survey_id number

Id of Survey

contact_id number

completed string

Status of the submission

channel_id number

Id of channel

language string

Language of the response

completed_time date

Time at which response completed

answers

object[]

Array [

question string

question_tags string[]

Question tags

question_id number

skipped boolean

Is the question skipped?

]

channel

object

name string

Name of the share

type string

Type of channel

status string

Status of channel

]

Example (from schema)

{
  "has_next_page": true,
  "data": [
    {
      "id": 1,
      "survey_id": 2,
      "contact_id": 0,
      "completed": "string",
      "channel_id": 3,
      "language": "en",
      "completed_time": "2022-03-03T06:19:04.416Z",
      "answers": [
        {
          "question": "How likely are you to recommend our Product to friends?",
          "question_tags": [
            "string"
          ],
          "question_id": 0,
          "skipped": false
        }
      ],
      "channel": {
        "name": "Email share 1",
        "type": "EMAIL",
        "status": "ACTIVE"
      }
    }
  ]
}

Loading...