Data export API v1 (deprecated)

Authentication

To authenticate your workspace please use your apikey accessible in Data Export API section and add it to your header in format Basic {{apiKey}} provided in Authorization header.

Methods

GET the list of surveys

Survey is a container for all the reponses in our database. As an object, all the properties it has is a name, ID and amount of responses collected.

Attribute	Type
id	string
name	string
responses	number

HTTP Request

GET /surveys

HTTP Responses

200 OK: Returns a list of all surveys from the workspace.
401 Unauthorised: You are probably missing API key in your call headers.
403 Forbidden: Your subscription is probably insufficient to use Export API.
404 Not found: We didn't get resources you asked for.

Response

GET survey responses

A survey response is one respondent's submission of a survey, whether they completed the survey or only partially completed it. API call returns a response as an array of questions and answers along with attributes of respondent, such as their name, email, or job position.

Attribute	Type	Description
custom_attributes	array	list of all custom attributes, along with their values
first_seen_date	string	date and time of first time visitor encountered any of your surveys
first_response_date	string	date and time of first time visitor responded to a survey
email	string	respondent's email
answers	array	list of questions and responses
survey_point	array	set of internal question data, such as id and question type
question	string	content of a question
answer	string	content of an answer
first_name	string	respondent's first name
last_name	string	respondent's last name
email	string	respondent's email
page_url	string	URL the survey was submitted on
language	string	survey translation language (if available)

To get more info about respondent's attributes please visit our knowledge base

HTTP Request

GET /surveys/{surveyId}/visitors

cURL

HTTP Responses

200 OK: Returns a list of all responses to a survey.
401 Unauthorised: You are probably missing API key in your call headers.
403 Forbidden: Your subscription is probably insufficient to use Export API.
404 Not found: We didn't get resources you asked for. Probably the survey was deleted.

Response

GET call parameters

We use pagination in our responses to avoid timeouts. If you get just a part of the results, please use ?page={{pageNumber}} param, where {{pageNumber}} is pagination page you want to collect
You can also filter responses using since and until parameters specified in UTC time ISO 8601. E. x. endpoint with parameters: surveys/{{surveyId}}/visitors?since=2019-04-12T10:11:00Z&until=2019-04-15T10:11:00Z will return responses submitted between 2019-04-12 10:11:00 and 2019-04-15 10:11:00
By default responses are returned in ascending order (from oldest to latest). If you want them to be returned in descending order (from latest to oldest), please use ?order=desc param

cURL

GET single survey data

This method returns list of questions and possible answers, along with their IDs. It can be used in JavaScrips interactions with your surveys, such as setting up EventListeners and setting up custom functions after a response.

Attribute	Type	Description
name	string	name of a survey
points	array	list of questions
answer_type	string	type of answer - can be text, multiple choice, matrix etc.
answers	array	list of answers that user can choose from - each answer has it's id and content

HTTP Request

GET /surveys/{{surveyId}}

cURL

HTTP Responses

200 OK: Returns a list of questions and possible answers.
401 Unauthorised: You are probably missing API key in your call headers.
403 Forbidden: Your subscription is probably insufficient to use Export API.
404 Not found: We didn't get resources you asked for.

Response

GET visitor info

Visitor is a person responding to a survey. We collect information about visitors throughout surveys, and assign responses to proper visitors. This way, you can easily show all responses of one person along with any attributes collected.

HTTP Request

GET /visitors/{visitorId}

GET /visitors/{visitorUuid}

cURL

HTTP Responses

200 OK: Returns all responses and attributes of a visitor.
401 Unauthorised: You are probably missing API key in your call headers.
403 Forbidden: Your subscription is probably insufficient to use Export API.
404 Not found: We didn't get resources you asked for. Probably the visitor was deleted.