API Reference

Get Answers

Log in to see full request history

Description

This endpoint returns all open-text responses. 
The response is full-text responses to the open-text questions.
The user requests full open text submissions that can be filtered by: Geographical division AND/OR Demographics (Age, Ethnicity, Gender, Education, Income).

For each open text response on your survey, the API call response will return the demographic labels attached to the response (gender, age group, and ethnicity) and the relevant geographical area assigned to the response.

This endpoint supports pagination, supporting the next path params:

  • page_size – Integer (limit is 100 items per page).
  • page – Integer, represents the page number.
Query Params
int32

Items per page (limit is 100 items per page)

int32
Defaults to 1

Represents the page number.

int32

Represents the identifier of a Survey Group (know your survey group first)

int32

Represents the identifier(s) of a generic question to filter by.

date

Filtering by the submitted_at of a Submission (>=)

date

Filtering by the submitted_at of a Submission. (<=).

string

Comma separated integers, represents the identifier(s) of gender choice(s) to filter by.

string

Comma separated integers, represents the identifier(s) of ethnicity choice(s) to filter by.

string

Comma separated integers, represents the identifier(s) of age group choice(s) to filter by.

string

Comma separated integers, represents the identifier(s) of education choice(s) to filter by.

string

Comma separated integers, represents the identifier(s) of income choice(s) to filter by.

string

Comma separated integers, represents the identifier(s) of divisions of submission area to filter by.

Responses

Language
Credentials
OAuth2
Request
Click Try It! to start a request and see the response here! Or choose an example:
application/json