API V2
API V2
https://{{env}}.questionpro.com/a/api/v2/surveys/{{survey-id}}/datapads?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}}/datapads?page=1&perPage=100&apiKey={{apiKey}}'
import requests
url = "https://{{env}}.questionpro.com/a/api/v2/surveys/{{survey-id}}/datapads"
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 =>"{{env}}.questionpro.com/a/api/v2/surveys/{{survey-id}}/datapads?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": [
{
"datapadID": 123,
"title": "Test",
"description":
"Covid 19\n ",
"analysisHtmlText": "Testing analytics",
"urls": {
"report": "https://{{env}}.questionpro.com/t/4GHZRIYe",
"csv": "https://{{env}}.questionpro.com/a/ds/?t=r0bEfU09g7edSR%2Bq/TIKIMNQGgIKyO3q0EWSVauZdQ315sL6NeGaXtYDDlk2/qnR",
"excel": "https://{{env}}.questionpro.com/a/ds/?t=14dAcs9D0spgpdnY6jPdKtsjQnuOkzzTbBPOWbyqd6/q6g%2BIlV5jZ353jZsB40gc" },
"surveyID": 1234567
},
{
"datapadID": 234,
"title": "Covid 19 Survey",
"description": "The Sample Survey survey was fielded on 08/Apr/2020 and about 118 respondents took the survey. The survey was administered using QuestionPro. This allowed users to submit their responses securely online. Listed below are the key findings.\n ",
"analysisHtmlText": "HTML Text",
"urls": {
"report": "https://{{env}}.questionpro.com/t/4EaZRiYe",
"csv": "https://{{env}}.questionpro.com/a/ds/?t=LWugFeIJJqMXaUtKxqfEurY6UCizdSFuQ5LUgxbi%2BZoKbBq0tVqT4IcEJ4Vj3Cl2",
"excel": "https://{{env}}.questionpro.com/a/ds/?t=obALESchMruWjC3MHPHuXX1tpFOLPBjodSA69q6OLK9MF4ZMVV4u0gbKD5n9rO3y"},
"surveyID": 1234567
}
],
"pagination":
{
"perPage": 100,
"totalItems": 2,
"currentPage": 1,
"totalPages": 1,
"links": {
"self": "https://{{env}}.questionpro.com/a/api/v2/surveys/{{survey-id}}/datapads/?page=1&perPage=100&apiKey={{apiKey}}",
"prev": null,
"next": null,
"first": "https://{{env}}.questionpro.com/a/api/v2/surveys/{{survey-id}}/datapads/?page=1&perPage=100&apiKey={{apiKey}}",
"last": "https://{{env}}.questionpro.com/a/api/v2/surveys/{{survey-id}}/datapads/?page=1&perPage=100&apiKey={{apiKey}}"
}
} ,
"requestID": "8012fedc-e8ce-48ae-b800-6q5ce287987a7daa"
}
{
"$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": "array",
"items": {
"type": "object",
"properties": {
"urls": {
"type": "object",
"properties": {
"excel": {
"type": "string"
},
"csv": {
"type": "string"
},
"report": {
"type": "string"
}
},
"additionalProperties": false,
"required": [
"excel",
"csv",
"report"
]
},
"surveyID": {
"type": "integer"
},
"description": {
"type": "string"
},
"datapadID": {
"type": "integer"
},
"analysisHtmlText": {
"type": "string"
},
"title": {
"type": "string"
}
},
"additionalProperties": false,
"required": [
"urls",
"surveyID",
"description",
"datapadID",
"analysisHtmlText",
"title"
]
}
},
"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"
]
}