API V2
API V2
https://{{env}}.questionpro.com/a/api/v2/surveys/{{survey-id}}/batches/{{batch-id}}?page=1&perPage=100&apiKey={{apiKey}}
The value of environment {{env}} variable depends upon your datacenter. Refer to the Environment page for more details.
curl --request GET \
--url 'https://{{env}}.questionpro.com/a/api/v2/surveys/{{survey-id}}/batches/{{batch-id}}?page=1&perPage=100&apiKey={{apiKey}}'
import requests
url = "https://{{env}}.questionpro.com/a/api/v2/surveys/{{survey-id}}/batches/{{batch-id}}"
querystring = {"page":"1","perPage":"100","apiKey":"{{apiKey}}"}
response = requests.request("GET", url, 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}}/batches/{{batch-id}}?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 => "GET",
));
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error # :" . $err;
} else {
echo $response;
}
?>
{
"response": {
"emailBatchID": 1234567,
"surveyID": 7654321,
"userID": 9876543,
"batchName": null,
"subject": "Survey Invitation",
"description": "Email List : Email-List-8",
"emailText": "Hello,\r\n\r\nWe would appreciate your feedback in our online survey. All responses will remain confidential and secure. Thank you in advance for your valuable insights. Your input will be used to ensure that we continue to meet your needs. We appreciate your trust and look forward to serving you in the future.\r\n\r\nWe have contracted with QuestionPro, an independent research firm, to field your confidential survey responses. Please click on this link to complete the survey:\r\n\r\n<SURVEY_LINK>\r\n\r\nPlease contact email@domain.com with any questions.\r\n\r\nThank You",
"status": 2,
"batchType": 1,
"emailCount": 3,
"emailFrom": "email@domain.com",
"creationDate": "2019-03-13T16:48:14.000+00:00",
"emailStatsList": [
{
"emailAddress": "respondent1@emaildomain.com",
"responseID": 0,
"custom1": "",
"custom2": "",
"custom3": "",
"custom4": "",
"custom5": "",
"status": "Pending"
},
{
"emailAddress": "respondent2@emaildomain.com",
"responseID": 10000001,
"custom1": "uio",
"custom2": "rty",
"custom3": "qwe",
"custom4": "xyz",
"custom5": "abc",
"status": "Started"
},
{
"emailAddress": "respondent3@emaildomain.com",
"responseID": 10000002,
"custom1": "abc",
"custom2": "xyz",
"custom3": "qwe",
"custom4": "xyz",
"custom5": "uio",
"status": "Taken"
}
],
"emailFromName": "Survey Administrator",
"emailBatchStatistics": {
"queuedCount": 0,
"sentCount": 3,
"errorCount": 0,
"startedCount": 1,
"viewedCount": 0,
"takenCount": 1,
"blockedCount": 0,
"participationPendingCount": 1,
"unSubscribedCount": 0
}
},
"pagination": {
"perPage": 100,
"totalItems": 3,
"currentPage": 1,
"totalPages": 1,
"links": {
"self": "https://{{env}}.questionpro.com/a/api/v2/surveys/{{survey-id}}/batches/{{batch-id}}?page=1&perPage=100&apiKey={{apiKey}}",
"prev": null,
"next": null,
"first": "https://{{env}}.questionpro.com/a/api/v2/surveys/{{survey-id}}/batches/{{batch-id}}?page=1&perPage=100&apiKey={{apiKey}}",
"last": "https://{{env}}.questionpro.com/a/api/v2/surveys/{{survey-id}}/batches/{{batch-id}}?page=1&perPage=100&apiKey={{apiKey}}"
}
}
}
{
"$schema": "http://json-schema.org/draft-06/schema# ",
"type": "object",
"properties": {
"pagination": {
"type": "object",
"properties": {
"totalItems": {
"type": "integer"
},
"perPage": {
"type": "integer"
},
"totalPages": {
"type": "integer"
},
"links": {
"type": "object",
"properties": {
"next": {
"type": "null"
},
"last": {
"type": "string"
},
"prev": {
"type": "null"
},
"self": {
"type": "string"
},
"first": {
"type": "string"
}
},
"additionalProperties": false,
"required": [
"last",
"self",
"first"
]
},
"currentPage": {
"type": "integer"
}
},
"additionalProperties": false,
"required": [
"totalItems",
"perPage",
"totalPages",
"links",
"currentPage"
]
},
"response": {
"type": "object",
"properties": {
"batchName": {
"type": "null"
},
"surveyID": {
"type": "integer"
},
"emailStatsList": {
"type": "array",
"items": {
"type": "object",
"properties": {
"emailAddress": {
"type": "string",
"format": "email"
},
"custom3": {
"type": "string"
},
"custom4": {
"type": "string"
},
"custom1": {
"type": "string"
},
"custom2": {
"type": "string"
},
"custom5": {
"type": "string"
},
"responseID": {
"type": "integer"
},
"status": {
"type": "string"
}
},
"additionalProperties": false,
"required": [
"emailAddress",
"custom3",
"custom4",
"custom1",
"custom2",
"custom5",
"responseID",
"status"
]
}
},
"emailBatchStatistics": {
"type": "object",
"properties": {
"unSubscribedCount": {
"type": "integer"
},
"blockedCount": {
"type": "integer"
},
"queuedCount": {
"type": "integer"
},
"viewedCount": {
"type": "integer"
},
"takenCount": {
"type": "integer"
},
"participationPendingCount": {
"type": "integer"
},
"startedCount": {
"type": "integer"
},
"errorCount": {
"type": "integer"
},
"sentCount": {
"type": "integer"
}
},
"additionalProperties": false,
"required": [
"unSubscribedCount",
"blockedCount",
"queuedCount",
"viewedCount",
"takenCount",
"participationPendingCount",
"startedCount",
"errorCount",
"sentCount"
]
},
"subject": {
"type": "string"
},
"description": {
"type": "string"
},
"emailText": {
"type": "string"
},
"creationDate": {
"type": "string"
},
"userID": {
"type": "integer"
},
"emailFromName": {
"type": "string"
},
"emailBatchID": {
"type": "integer"
},
"emailFrom": {
"type": "string",
"format": "email"
},
"batchType": {
"type": "integer"
},
"status": {
"type": "integer"
},
"emailCount": {
"type": "integer"
}
},
"additionalProperties": false,
"required": [
"surveyID",
"emailStatsList",
"emailBatchStatistics",
"subject",
"description",
"emailText",
"creationDate",
"userID",
"emailFromName",
"emailBatchID",
"emailFrom",
"batchType",
"status",
"emailCount"
]
}
},
"additionalProperties": false,
"required": [
"pagination",
"response"
]
}
{
"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"
]
}