Get all responses

GET 
/v3/responses

Get all responses

Request

Query Parameters

limit number

Possible values: >= 1 and <= 200

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
response_url boolean

Responses

200

Successful

*/*

Schema

Schema

total_count number
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?

sentiment_value number

Sentiment value of the text answer

sentiment_label string

Overall sentiment label of the text answer

enrich_type string

Enrich type. CLASSIFICATION, KEYWORD_EXTRACTION, ENTITY_EXTRACTION and TOPIC_EXTRACTION return an array; SUMMARY, SENTIMENT, TRANSLATION, CUSTOM_PROMPT and ENRICH_FORMULA return a single value

output_datatype string

Configured output datatype - STRING, NUMBER or BOOLEAN

error boolean

Present only when the value could not be generated; the answer is then empty

error_reason string

Possible values: [AI_PROCESSING_FAILED, AI_CREDITS_EXHAUSTED, NO_INPUT_FOUND, PLAN_UPGRADE_REQUIRED]

Why the Enrich value is missing

credit_exhausted boolean

Present only when generation stopped because AI credits ran out

]

channel

object

name string

Name of the share

type string

Type of channel

status string

Status of channel

]

Example (from schema)

{
  "total_count": 100,
  "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,
          "sentiment_value": 0.82,
          "sentiment_label": "Positive",
          "enrich_type": "SENTIMENT",
          "output_datatype": "STRING",
          "error": true,
          "error_reason": "AI_PROCESSING_FAILED",
          "credit_exhausted": true
        }
      ],
      "channel": {
        "name": "Email share 1",
        "type": "EMAIL",
        "status": "ACTIVE"
      }
    }
  ]
}

Loading...