API V2
API V2
https://api.questionpro.{{env}}/a/api/v2/surveys/{{survey-id}}/batches/{{batch-id}}
The value of environment {{env}} variable depends upon your datacenter. Refer to the Environment page for more details.
curl --location 'https://api.questionpro.{{env}}/a/api/v2/surveys/{{survey-id}}/batches/{{batch-id}}' \
--header 'api-key: {{api-key}}'
import requests
url = "https://api.questionpro.{{env}}/a/api/v2/surveys/{{survey-id}}/batches/{{batch-id}}"
payload = {}
headers = {
'api-key': '{{api-key}}'
}
response = requests.request("GET", url, headers=headers, data=payload)
print(response.text)
<?php
$curl = curl_init();
curl_setopt_array($curl, array(
CURLOPT_URL => 'https://api.questionpro.{{env}}/a/api/v2/surveys/{{survey-id}}/batches/{{batch-id}}',
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => '',
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 0,
CURLOPT_FOLLOWLOCATION => true,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => 'GET',
CURLOPT_HTTPHEADER => array(
'api-key: {{api-key}}'
),
));
$response = curl_exec($curl);
curl_close($curl);
echo $response;
Note: To fetch the emailStatsList please refer to the Get Batch Statistics page for API endpoint details.
{
"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 protected] with any questions.\r\n\r\nThank You",
"status": 2,
"batchType": 1,
"emailCount": 3,
"emailFrom": "[email protected]",
"creationDate": "2019-03-13T16:48:14.000+00:00",
"emailStatsList": [],
"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://api.questionpro.{{env}}/a/api/v2/surveys/{{survey-id}}/batches/{{batch-id}}?page=1&perPage=100",
"prev": null,
"next": null,
"first": "https://api.questionpro.{{env}}/a/api/v2/surveys/{{survey-id}}/batches/{{batch-id}}?page=1&perPage=100",
"last": "https://api.questionpro.{{env}}/a/api/v2/surveys/{{survey-id}}/batches/{{batch-id}}?page=1&perPage=100"
}
},
"requestID": "4012fedc-e8ce-48ae-b800-6q5ce287987a7dje"
}
{
"$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"
},
"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"
]
},
"requestID": {
"type": "string"
}
},
"additionalProperties": false,
"required": [
"pagination",
"response",
"requestID"
]
}
{
"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"
]
}