API V2
API V2
https://{{env}}.questionpro.com/a/api/v2/surveys/{{survey-id}}/responses/filter?page=1&perPage=100&apiKey={{apiKey}}
The value of environment {{env}} variable depends upon your datacenter. Refer to the Environment page for more details.
{
"resultMode":2,
"startDate":"2020-01-01",
"endDate":"2020-12-31",
"custom1":"Test",
"highCustomVariables":{"custom7":"Operator","custom254":"Sales"}
}
Supported custom variables - "custom1" to "custom5"
Supported high custom variables - custom6 to "custom255"
curl --request POST \
--url 'https://{{env}}.questionpro.com/a/api/v2/surveys/{{survey-id}}/responses/filter?page=1&perPage=100&apiKey={{apiKey}}' \
--header 'Content-Type: application/json' \
--data '{
"resultMode": 2,
"startDate": "2020-01-01",
"endDate": "2020-12-31",
"custom1":"Test",
"highCustomVariables":{"custom7":"Operator","custom254":"Sales"}
}'
import requests
url = "https://{{env}}.questionpro.com/a/api/v2/surveys/{{survey-id}}/responses/filter"
querystring = {"page":"1","perPage":"100","apiKey":"{{apiKey}}"}
payload = "{"resultMode": 2,"startDate":"2020-01-01","endDate":"2020-12-31","custom1":"Test","highCustomVariables":{"custom7":"Operator","custom254":"Sales"}"
headers = {'Content-Type': 'application/json'}
response = requests.request("POST", url, data=payload, headers=headers, params=querystring)
print(response.text)
<?php
$curl = curl_init();
curl_setopt_array($curl, array(
CURLOPT_URL =>"https://{{env}}.questionpro.com/a/api/v2/surveys/{{survey-id}}/responses/filter?page=1&perPage=100&apiKey={{apiKey}}",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "POST",
CURLOPT_POSTFIELDS => "{"resultMode": 2,"startDate":"2020-01-01","endDate":"2020-12-31","custom1":"Test","highCustomVariables":{"custom7":"Operator","custom254":"Sales"}",
CURLOPT_HTTPHEADER => array(
"Content-Type: application/json"
),
));
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error # :" . $err;
} else {
echo $response;
}
?>
{
"response": [
{
"responseID": 12345678,
"surveyID": 7654321,
"surveyName": "Test Survey",
"ipAddress": "192.168.0.1",
"timestamp": "05 Oct, 2020 02:51:51 PM PDT",
"location": {
"country": null,
"region": "16",
"latitude": 0.0,
"longitude": 0.0,
"radius": 0.0,
"countryCode": "IN"
},
"duplicate": false,
"timeTaken": 41,
"responseStatus": "Completed",
"externalReference": "",
"customVariables": {
"custom1": "Test",
"custom7": "Operator",
"custom254": "Sales"
},
"language": "English",
"currentInset": "",
"operatingSystem": "WINDOWS_10",
"osDeviceType": "COMPUTER",
"browser": "CHROME8",
"responseSet": [
{
"questionID": 12345678,
"questionDescription": " ",
"questionCode": "Q1",
"questionText": "How often do you conduct surveys?",
"imageUrl": null,
"answerValues": [
{
"answerID": 123456789,
"answerText": "Always",
"value": {
"scale": "1",
"other": "",
"dynamicExplodeText": "",
"text": "",
"result": "",
"fileLink": "",
"weight": 0.0
}
}
]
},
{
"questionID": 12345679,
"questionDescription": "Contact Information",
"questionCode": "Q2_1",
"questionText": "First Name",
"imageUrl": null,
"answerValues": [
{
"answerID": 100000001,
"answerText": "FIRST_NAME",
"value": {
"scale": "",
"other": "",
"dynamicExplodeText": "",
"text": "FirstName",
"result": "",
"fileLink": "",
"weight": 0.0
}
}
]
},
{
"questionID": 83734737,
"questionDescription": " ",
"questionCode": "Q2_2",
"questionText": "Last Name",
"imageUrl": null,
"answerValues": [
{
"answerID": 100000002,
"answerText": "LAST_NAME",
"value": {
"scale": "",
"other": "",
"dynamicExplodeText": "",
"text": "LastName",
"result": "",
"fileLink": "",
"weight": 0.0
}
}
]
},
{
"questionID": 83734738,
"questionDescription": " ",
"questionCode": "Q2_3",
"questionText": "Phone",
"imageUrl": null,
"answerValues": [
{
"answerID": 100000003,
"answerText": "PHONE",
"value": {
"scale": "",
"other": "",
"dynamicExplodeText": "",
"text": "123-456-7890",
"result": "",
"fileLink": "",
"weight": 0.0
}
}
]
},
{
"questionID": 83734739,
"questionDescription": " ",
"questionCode": "Q2_4",
"questionText": "Email Address",
"imageUrl": null,
"answerValues": [
{
"answerID": 100000004,
"answerText": "EMAIL",
"value": {
"scale": "",
"other": "",
"dynamicExplodeText": "",
"text": "respondentemail@emaildomain.com",
"result": "",
"fileLink": "",
"weight": 0.0
}
}
]
},
{
"responseID": 12345677,
"surveyID": 7654321,
"surveyName": "Test Survey",
"ipAddress": "192.168.0.1",
"timestamp": "05 Oct, 2020 02:51:51 PM PDT",
"location": {
"country": null,
"region": "20",
"latitude": 0.0,
"longitude": 0.0,
"radius": 0.0,
"countryCode": "IN"
},
"duplicate": false,
"timeTaken": 41,
"responseStatus": "Completed",
"externalReference": "",
"customVariables": {
"custom1": "Test",
"custom7": "Operator",
"custom254": "Sales"
},
"language": "English",
"currentInset": "",
"operatingSystem": "WINDOWS_10",
"osDeviceType": "COMPUTER",
"browser": "CHROME8",
"responseSet": [
{
"questionID": 12345678,
"questionDescription": " ",
"questionCode": "Q1",
"questionText": "How often do you conduct surveys?",
"imageUrl": null,
"answerValues": [
{
"answerID": 123456789,
"answerText": "Always",
"value": {
"scale": "1",
"other": "",
"dynamicExplodeText": "",
"text": "",
"result": "",
"fileLink": "",
"weight": 0.0
}
}
]
},
{
"questionID": 12345679,
"questionDescription": "Contact Information",
"questionCode": "Q2_1",
"questionText": "First Name",
"imageUrl": null,
"answerValues": [
{
"answerID": 100000001,
"answerText": "FIRST_NAME",
"value": {
"scale": "",
"other": "",
"dynamicExplodeText": "",
"text": "FirstName",
"result": "",
"fileLink": "",
"weight": 0.0
}
}
]
},
{
"questionID": 83734737,
"questionDescription": " ",
"questionCode": "Q2_2",
"questionText": "Last Name",
"imageUrl": null,
"answerValues": [
{
"answerID": 100000002,
"answerText": "LAST_NAME",
"value": {
"scale": "",
"other": "",
"dynamicExplodeText": "",
"text": "LastName",
"result": "",
"fileLink": "",
"weight": 0.0
}
}
]
},
{
"questionID": 83734738,
"questionDescription": " ",
"questionCode": "Q2_3",
"questionText": "Phone",
"imageUrl": null,
"answerValues": [
{
"answerID": 100000003,
"answerText": "PHONE",
"value": {
"scale": "",
"other": "",
"dynamicExplodeText": "",
"text": "123-456-7890",
"result": "",
"fileLink": "",
"weight": 0.0
}
}
]
},
{
"questionID": 83734739,
"questionDescription": " ",
"questionCode": "Q2_4",
"questionText": "Email Address",
"imageUrl": null,
"answerValues": [
{
"answerID": 100000004,
"answerText": "EMAIL",
"value": {
"scale": "",
"other": "",
"dynamicExplodeText": "",
"text": "respondentemail@emaildomain.com",
"result": "",
"fileLink": "",
"weight": 0.0
}
}
]
}
],"utctimestamp": 51
}
],
"pagination": {
"perPage": 100,
"totalItems": 2,
"currentPage": 1,
"totalPages": 1,
"links": {
"self": "https://{{env}}.questionpro.com/a/api/v2/surveys/{{survey-id}}/responses/filter?page=1&perPage=100&apiKey={{apiKey}}",
"prev": null,
"next": null,
"first": "https://{{env}}.questionpro.com/a/api/v2/surveys/{{survey-id}}/responses/filter?page=1&perPage=100&apiKey={{apiKey}}",
"last": "https://{{env}}.questionpro.com/a/api/v2/surveys/{{survey-id}}/responses/filter?page=1&perPage=100&apiKey={{apiKey}}"
}
}
}
{
"response": [
{
"responseID": 12345678,
"surveyID": 7654321,
"surveyName": "Test Survey",
"ipAddress": "192.168.0.1",
"timestamp": "05 Oct, 2020 02:51:51 PM PDT",
"location": {
"country": null,
"region": "16",
"latitude": 0.0,
"longitude": 0.0,
"radius": 0.0,
"countryCode": "IN"
},
"duplicate": false,
"timeTaken": 41,
"responseStatus": "Completed",
"externalReference": "",
"customVariables": {
"custom1": "Test",
"custom7": "Operator",
"custom254": "Sales"
},
"language": "English",
"currentInset": "",
"operatingSystem": "WINDOWS_10",
"osDeviceType": "COMPUTER",
"browser": "CHROME8",
"responseSet": [
{
"questionID": 12345678,
"questionDescription": " ",
"questionCode": "Q1",
"questionText": "How often do you conduct surveys?",
"imageUrl": null,
"answerValues": [
{
"answerID": 123456789,
"answerText": "Always",
"value": {
"scale": "1",
"other": "",
"dynamicExplodeText": "",
"text": "",
"result": "",
"fileLink": "",
"weight": 0.0
}
}
]
},
{
"questionID": 12345679,
"questionDescription": "Contact Information",
"questionCode": "Q2_1",
"questionText": "First Name",
"imageUrl": null,
"answerValues": [
{
"answerID": 100000001,
"answerText": "FIRST_NAME",
"value": {
"scale": "",
"other": "",
"dynamicExplodeText": "",
"text": "FirstName",
"result": "",
"fileLink": "",
"weight": 0.0
}
}
]
},
{
"questionID": 83734737,
"questionDescription": " ",
"questionCode": "Q2_2",
"questionText": "Last Name",
"imageUrl": null,
"answerValues": [
{
"answerID": 100000002,
"answerText": "LAST_NAME",
"value": {
"scale": "",
"other": "",
"dynamicExplodeText": "",
"text": "LastName",
"result": "",
"fileLink": "",
"weight": 0.0
}
}
]
},
{
"questionID": 83734738,
"questionDescription": " ",
"questionCode": "Q2_3",
"questionText": "Phone",
"imageUrl": null,
"answerValues": [
{
"answerID": 100000003,
"answerText": "PHONE",
"value": {
"scale": "",
"other": "",
"dynamicExplodeText": "",
"text": "123-456-7890",
"result": "",
"fileLink": "",
"weight": 0.0
}
}
]
},
{
"questionID": 83734739,
"questionDescription": " ",
"questionCode": "Q2_4",
"questionText": "Email Address",
"imageUrl": null,
"answerValues": [
{
"answerID": 100000004,
"answerText": "EMAIL",
"value": {
"scale": "",
"other": "",
"dynamicExplodeText": "",
"text": "respondentemail@emaildomain.com",
"result": "",
"fileLink": "",
"weight": 0.0
}
}
]
},
{
"responseID": 12345677,
"surveyID": 7654321,
"surveyName": "Test Survey",
"ipAddress": "192.168.0.1",
"timestamp": "05 Oct, 2020 02:51:51 PM PDT",
"location": {
"country": null,
"region": "20",
"latitude": 0.0,
"longitude": 0.0,
"radius": 0.0,
"countryCode": "IN"
},
"duplicate": false,
"timeTaken": 41,
"responseStatus": "Completed",
"externalReference": "",
"customVariables": {
"custom1": "Test",
"custom7": "Operator",
"custom254": "Sales"
},
"language": "English",
"currentInset": "",
"operatingSystem": "WINDOWS_10",
"osDeviceType": "COMPUTER",
"browser": "CHROME8",
"responseSet": [
{
"questionID": 12345678,
"questionDescription": " ",
"questionCode": "Q1",
"questionText": "How often do you conduct surveys?",
"imageUrl": null,
"answerValues": [
{
"answerID": 123456789,
"answerText": "Always",
"value": {
"scale": "1",
"other": "",
"dynamicExplodeText": "",
"text": "",
"result": "",
"fileLink": "",
"weight": 0.0
}
}
]
},
{
"questionID": 12345679,
"questionDescription": "Contact Information",
"questionCode": "Q2_1",
"questionText": "First Name",
"imageUrl": null,
"answerValues": [
{
"answerID": 100000001,
"answerText": "FIRST_NAME",
"value": {
"scale": "",
"other": "",
"dynamicExplodeText": "",
"text": "FirstName",
"result": "",
"fileLink": "",
"weight": 0.0
}
}
]
},
{
"questionID": 83734737,
"questionDescription": " ",
"questionCode": "Q2_2",
"questionText": "Last Name",
"imageUrl": null,
"answerValues": [
{
"answerID": 100000002,
"answerText": "LAST_NAME",
"value": {
"scale": "",
"other": "",
"dynamicExplodeText": "",
"text": "LastName",
"result": "",
"fileLink": "",
"weight": 0.0
}
}
]
},
{
"questionID": 83734738,
"questionDescription": " ",
"questionCode": "Q2_3",
"questionText": "Phone",
"imageUrl": null,
"answerValues": [
{
"answerID": 100000003,
"answerText": "PHONE",
"value": {
"scale": "",
"other": "",
"dynamicExplodeText": "",
"text": "123-456-7890",
"result": "",
"fileLink": "",
"weight": 0.0
}
}
]
},
{
"questionID": 83734739,
"questionDescription": " ",
"questionCode": "Q2_4",
"questionText": "Email Address",
"imageUrl": null,
"answerValues": [
{
"answerID": 100000004,
"answerText": "EMAIL",
"value": {
"scale": "",
"other": "",
"dynamicExplodeText": "",
"text": "respondentemail@emaildomain.com",
"result": "",
"fileLink": "",
"weight": 0.0
}
}
]
}
],"utctimestamp": 51
}
],
"pagination": {
"perPage": 100,
"totalItems": 2,
"currentPage": 1,
"totalPages": 1,
"links": {
"self": "https://{{env}}.questionpro.com/a/api/v2/surveys/{{survey-id}}/responses/filter?page=1&perPage=100&apiKey={{apiKey}}",
"prev": null,
"next": null,
"first": "https://{{env}}.questionpro.com/a/api/v2/surveys/{{survey-id}}/responses/filter?page=1&perPage=100&apiKey={{apiKey}}",
"last": "https://{{env}}.questionpro.com/a/api/v2/surveys/{{survey-id}}/responses/filter?page=1&perPage=100&apiKey={{apiKey}}"
}
}
}
{
"response": {
"error": {
"docs": www.questionpro.com/api/error-codes.html
"name": "BAD_REQUEST",
"httpStatusCode": 400,
"id" : "1000",
"message": "Invalid URL parameters",
"resourceUrl":"resource_url"
}
}
}
{
"$schema": "http://json-schema.org/draft-06/schema# ",
"type": "object",
"properties": {
"response": {
"type": "object",
"properties": {
"error": {
"type": "object",
"properties": {
"docs": {
"type": "string"
},
"resourceUrl": {
"type": "string"
},
"name": {
"type": "string"
},
"id": {
"type": "string"
},
"message": {
"type": "string"
},
"httpStatusCode": {
"type": "integer"
}
},
"additionalProperties": false,
"required": [
"docs",
"resourceUrl",
"name",
"id",
"message",
"httpStatusCode"
]
}
},
"additionalProperties": false,
"required": [
"error"
]
}
},
"additionalProperties": false,
"required": [
"response"
]
}
{
"response": {
"error": {
"docs": www.questionpro.com/api/error-codes.html
"name": "UNAUTHORIZED",
"httpStatusCode": 401,
"id" : "1010",
"message": "Incorrect API Key",
"resourceUrl":"resource_url"
}
}
}
{
"$schema": "http://json-schema.org/draft-06/schema# ",
"type": "object",
"properties": {
"response": {
"type": "object",
"properties": {
"error": {
"type": "object",
"properties": {
"docs": {
"type": "string"
},
"resourceUrl": {
"type": "string"
},
"name": {
"type": "string"
},
"id": {
"type": "string"
},
"message": {
"type": "string"
},
"httpStatusCode": {
"type": "integer"
}
},
"additionalProperties": false,
"required": [
"docs",
"resourceUrl",
"name",
"id",
"message",
"httpStatusCode"
]
}
},
"additionalProperties": false,
"required": [
"error"
]
}
},
"additionalProperties": false,
"required": [
"response"
]
}
{
"response": {
"error": {
"docs": www.questionpro.com/api/error-codes.html
"name": "FORBIDDEN",
"httpStatusCode": 403,
"id" : "1013",
"message": "The user does not have permission to access the resource",
"resourceUrl":"resource_url"
}
}
}
{
"$schema": "http://json-schema.org/draft-06/schema# ",
"type": "object",
"properties": {
"response": {
"type": "object",
"properties": {
"error": {
"type": "object",
"properties": {
"docs": {
"type": "string"
},
"resourceUrl": {
"type": "string"
},
"name": {
"type": "string"
},
"id": {
"type": "string"
},
"message": {
"type": "string"
},
"httpStatusCode": {
"type": "integer"
}
},
"additionalProperties": false,
"required": [
"docs",
"resourceUrl",
"name",
"id",
"message",
"httpStatusCode"
]
}
},
"additionalProperties": false,
"required": [
"error"
]
}
},
"additionalProperties": false,
"required": [
"response"
]
}
{
"response": {
"error": {
"docs": www.questionpro.com/api/error-codes.html
"name": "NOT_FOUND",
"httpStatusCode": 404,
"id" : "1040",
"message": "The resource that you're trying to access doesn't exist",
"resourceUrl":"resource_url"
}
}
}
{
"$schema": "http://json-schema.org/draft-06/schema# ",
"type": "object",
"properties": {
"response": {
"type": "object",
"properties": {
"error": {
"type": "object",
"properties": {
"docs": {
"type": "string"
},
"resourceUrl": {
"type": "string"
},
"name": {
"type": "string"
},
"id": {
"type": "string"
},
"message": {
"type": "string"
},
"httpStatusCode": {
"type": "integer"
}
},
"additionalProperties": false,
"required": [
"docs",
"resourceUrl",
"name",
"id",
"message",
"httpStatusCode"
]
}
},
"additionalProperties": false,
"required": [
"error"
]
}
},
"additionalProperties": false,
"required": [
"response"
]
}
{
"response": {
"error": {
"docs": www.questionpro.com/api/error-codes.html
"name": "INTERNAL_SERVER_ERROR",
"httpStatusCode": 500,
"id" : "1026",
"message": "We are not able to process your request",
"resourceUrl":"resource_url"
}
}
}
{
"$schema": "http://json-schema.org/draft-06/schema# ",
"type": "object",
"properties": {
"response": {
"type": "object",
"properties": {
"error": {
"type": "object",
"properties": {
"docs": {
"type": "string"
},
"resourceUrl": {
"type": "string"
},
"name": {
"type": "string"
},
"id": {
"type": "string"
},
"message": {
"type": "string"
},
"httpStatusCode": {
"type": "integer"
}
},
"additionalProperties": false,
"required": [
"docs",
"resourceUrl",
"name",
"id",
"message",
"httpStatusCode"
]
}
},
"additionalProperties": false,
"required": [
"error"
]
}
},
"additionalProperties": false,
"required": [
"response"
]
}