API V2
API V2
https://api.questionpro.{{env}}/a/api/v2/cx/transactions/email-engagement?page=1&perPage=100
The value of environment {{env}} variable depends upon your datacenter. Refer to the Environment page for more details.
{
"transactionEndDate": "28/07/2023",
"transactionStartDate": "27/01/2022",
"status":["skipped”]
}
{
"response": [
{
"firstName": "",
"lastName": "",
"mobile": "1234567890",
"sentDateAndTime": "2023-07-25 05:03:46",
"emailAddress": "[email protected]",
"surveyID": 1234,
"surveyName": "Survey 1",
"segment": "Main Segment ",
"segmentCode": "S2",
"status": "Skipped",
"responseStatus": "Pending",
"responseCompletionTimestamp": "",
"productName": "",
"productGroup": "",
"surveyURL": "https://www.xyz.com/t/adsddeq",
"importMechanism": "Manual/Excel",
"custom1": "",
"custom2": "",
"custom3": "",
"custom4": "",
"custom5": "",
"custom6": "",
"custom7": "",
"custom8": "",
"custom9": "",
"custom10": "",
"custom11": "",
"custom12": "",
"custom13": "",
"custom14": "",
"custom15": "",
"custom16": "",
"custom17": "",
"custom18": "",
"custom19": "",
"custom20": ""
}
],
"pagination": {
"perPage": 100,
"totalItems": 1,
"currentPage": 1,
"totalPages": 1,
"links": {
"self": "https://api.questionpro.{{env}}/a/api/v2/cx/email/engagement/data?page=1&perPage=100",
"prev": null,
"next": null,
"first": "https://api.questionpro.{{env}}/a/api/v2/cx/email/engagement/data?page=1&perPage=12",
"last": "https://api.questionpro.{{env}}/a/api/v2/cx/email/engagement/data?page=3&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": "array",
"items": {
"type": "object",
"properties": {
"lastName": {
"type": "string"
},
"productName": {
"type": "string"
},
"custom20": {
"type": "string"
},
"emailAddress": {
"type": "string",
"format": "email"
},
"custom9": {
"type": "string"
},
"surveyName": {
"type": "string"
},
"segment": {
"type": "string"
},
"custom3": {
"type": "string"
},
"custom4": {
"type": "string"
},
"custom1": {
"type": "string"
},
"custom2": {
"type": "string"
},
"custom7": {
"type": "string"
},
"custom8": {
"type": "string"
},
"custom5": {
"type": "string"
},
"custom6": {
"type": "string"
},
"sentDateAndTime": {
"type": "string"
},
"surveyID": {
"type": "integer"
},
"responseCompletionTimestamp": {
"type": "string"
},
"surveyURL": {
"type": "string"
},
"mobile": {
"type": "string"
},
"importMechanism": {
"type": "string"
},
"segmentCode": {
"type": "string"
},
"responseStatus": {
"type": "string"
},
"custom11": {
"type": "string"
},
"firstName": {
"type": "string"
},
"custom10": {
"type": "string"
},
"custom13": {
"type": "string"
},
"custom12": {
"type": "string"
},
"custom15": {
"type": "string"
},
"productGroup": {
"type": "string"
},
"custom14": {
"type": "string"
},
"custom17": {
"type": "string"
},
"custom16": {
"type": "string"
},
"custom19": {
"type": "string"
},
"custom18": {
"type": "string"
},
"status": {
"type": "string"
}
},
"additionalProperties": false,
"required": [
"lastName",
"productName",
"custom20",
"emailAddress",
"custom9",
"surveyName",
"segment",
"custom3",
"custom4",
"custom1",
"custom2",
"custom7",
"custom8",
"custom5",
"custom6",
"sentDateAndTime",
"surveyID",
"responseCompletionTimestamp",
"surveyURL",
"mobile",
"importMechanism",
"segmentCode",
"responseStatus",
"custom11",
"firstName",
"custom10",
"custom13",
"custom12",
"custom15",
"productGroup",
"custom14",
"custom17",
"custom16",
"custom19",
"custom18",
"status"
]
}
},
"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"
]
}