API V2
API V2
https://api.questionpro.{{env}}/a/api/v2/cx/surveys/{{surveyID}}/responses
The value of environment {{env}} variable depends upon your datacenter. Refer to the Environment page for more details.
{
"ipAddress": "127.0.0.12",
"timestamp": "08 Jan, 2018 04:08:59 PM IST",
"location": {
"country": "India",
"region": "Pune",
"latitude": 0,
"longitude": 0,
"radius": 0
},
"duplicate": false,
"timeTaken": 58,
"responseStatus": "Completed",
"externalReference": "test_response",
"customVariables": {
"custom1": null,
"custom2": null,
"custom3": null,
"custom4": null,
"custom5": null
},
"language": "English",
"currentInset": "",
"operatingSystem": "LINUX",
"osDeviceType": "COMPUTER",
"browser": "CHROME",
"segmentCode": "AD",
"responseSet": [
{
"questionID": 118394888,
"questionDescription": "{detractor:Very Unlikely,promoter:Very Likely}",
"questionCode": "Q1",
"questionText": "How likely is it that you would recommend {company/product/service} to a friend or colleague?",
"imageUrl": null,
"answerValues": [
{
"answerID": 631380465,
"answerText": "7",
"value": {
"scale": "8",
"other": "",
"dynamicExplodeText": "",
"text": "",
"result": "",
"fileLink": "",
"weight": 0.0
}
}
]
},
{
"questionID": 118394889,
"questionDescription": "",
"questionCode": "Q2",
"questionText": "What is the primary reason for your score?",
"imageUrl": null,
"answerValues": [
{
"answerID": 631380469,
"answerText": "",
"value": {
"scale": "",
"other": "",
"dynamicExplodeText": "",
"text": "Test Data",
"result": "",
"fileLink": "",
"weight": 0.0
}
}
]
}
],
"utctimestamp": 59
}
{
"response": {
"responseID": 101049875,
"surveyID": 10719714,
"surveyName": "cx import responses api",
"ipAddress": "127.0.0.12",
"timestamp": "05 Jan, 2023 01:42:24 AM PST",
"location": {
"country": "India",
"region": "Pune",
"latitude": 0.0,
"longitude": 0.0,
"radius": 0.0,
"countryCode": null
},
"duplicate": false,
"timeTaken": 58,
"responseStatus": "Completed",
"externalReference": "test_response",
"customVariables": {
"custom1": null,
"custom2": null,
"custom3": null,
"custom4": null,
"custom5": null
},
"language": "English",
"currentInset": "",
"operatingSystem": "",
"osDeviceType": "",
"browser": "",
"responseSet": [
{
"questionID": 118394888,
"questionDescription": "{detractor:Very Unlikely,promoter:Very Likely}",
"questionCode": "Q1",
"questionText": "How likely is it that you would recommend {company/product/service} to a friend or colleague?",
"imageUrl": null,
"answerValues": [
{
"answerID": 631380465,
"answerText": "7",
"value": {
"scale": "8",
"other": "",
"dynamicExplodeText": "",
"text": "",
"result": "",
"fileLink": "",
"weight": 0.0
}
}
]
},
{
"questionID": 118394889,
"questionDescription": "",
"questionCode": "Q2",
"questionText": "What is the primary reason for your score?",
"imageUrl": null,
"answerValues": [
{
"answerID": 631380469,
"answerText": "",
"value": {
"scale": "",
"other": "",
"dynamicExplodeText": "",
"text": "Test Data",
"result": "",
"fileLink": "",
"weight": 0.0
}
}
]
}
],
"productDetails": [],
"utctimestamp": 1672911744
},
"requestID": "4012fedc-e8ce-48ae-b800-6q5ce287987a7dje"
}
{
"$schema": "http://json-schema.org/draft-06/schema# ",
"type": "object",
"properties": {
"response": {
"type": "object",
"properties": {
"surveyID": {
"type": "integer"
},
"ipAddress": {
"type": "string",
"format": "ipv4"
},
"language": {
"type": "string"
},
"duplicate": {
"type": "boolean"
},
"responseStatus": {
"type": "string"
},
"productDetails": {
"type": "array"
},
"operatingSystem": {
"type": "string"
},
"customVariables": {
"type": "object",
"properties": {
"custom3": {
"type": "null"
},
"custom4": {
"type": "null"
},
"custom1": {
"type": "null"
},
"custom2": {
"type": "null"
},
"custom5": {
"type": "null"
}
},
"additionalProperties": false
},
"externalReference": {
"type": "string"
},
"osDeviceType": {
"type": "string"
},
"timeTaken": {
"type": "integer"
},
"currentInset": {
"type": "string"
},
"utctimestamp": {
"type": "integer"
},
"surveyName": {
"type": "string"
},
"browser": {
"type": "string"
},
"location": {
"type": "object",
"properties": {
"country": {
"type": "string"
},
"countryCode": {
"type": "null"
},
"latitude": {
"type": "number"
},
"region": {
"type": "string"
},
"radius": {
"type": "number"
},
"longitude": {
"type": "number"
}
},
"additionalProperties": false,
"required": [
"country",
"latitude",
"region",
"radius",
"longitude"
]
},
"responseSet": {
"type": "array",
"items": {
"type": "object",
"properties": {
"questionDescription": {
"type": "string"
},
"questionID": {
"type": "integer"
},
"questionCode": {
"type": "string"
},
"imageUrl": {
"type": "null"
},
"answerValues": {
"type": "array",
"items": {
"type": "object",
"properties": {
"answerID": {
"type": "integer"
},
"answerText": {
"type": "string"
},
"value": {
"type": "object",
"properties": {
"result": {
"type": "string"
},
"other": {
"type": "string"
},
"fileLink": {
"type": "string"
},
"scale": {
"type": "string"
},
"dynamicExplodeText": {
"type": "string"
},
"weight": {
"type": "number"
},
"text": {
"type": "string"
}
},
"additionalProperties": false,
"required": [
"result",
"other",
"fileLink",
"scale",
"dynamicExplodeText",
"weight",
"text"
]
}
},
"additionalProperties": false,
"required": [
"answerID",
"answerText",
"value"
]
}
},
"questionText": {
"type": "string"
}
},
"additionalProperties": false,
"required": [
"questionDescription",
"questionID",
"questionCode",
"answerValues",
"questionText"
]
}
},
"responseID": {
"type": "integer"
},
"timestamp": {
"type": "string"
}
},
"additionalProperties": false,
"required": [
"surveyID",
"ipAddress",
"language",
"duplicate",
"responseStatus",
"productDetails",
"operatingSystem",
"customVariables",
"externalReference",
"osDeviceType",
"timeTaken",
"currentInset",
"utctimestamp",
"surveyName",
"browser",
"location",
"responseSet",
"responseID",
"timestamp"
]
},
"requestID": {
"type": "string"
}
},
"additionalProperties": false,
"required": [
"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"
]
}