☰
Get Responses (JSON Format)
Views
POST:
https://{{env}}-api.xebo.ai/api/v1/export/responses/json
The value of environment {{env}} variable depends upon your datacenter. Refer to the Environment page for more details.
| Key | Type | Mandatory | Description |
| page | string | no | Gives the page value, by default it is 1 |
| page_size
|
string | no | The number of responses in a single page, by default it is 250. |
"Content-Type": "application/json"
Authorization:
type: Bearer type
token: <access token> granted from login API
Or
x-api-key: <api key copied from the platform>
Content-Type: application/json {
"survey_id":"4c5f13cf-0952-4b2f-88d6-13c3e40874c6",
"data_structure": "flat",
“date_filter”: {
operand:["2024-08-05","2024-08-06"]
type:"between"
},
"time_filter": {
"start": "2022-04-02 17:50:00",
“end”: “2024-06-01 11:32:00”
},
“response_status”: [0, 1, 2],
“collector_ids”: [“7c6f13cf-1053-4b2f-88d6-13c5e31353d2”]
} CURL
curl --location 'https://az4-api.xebo.ai/api/v1/export/responses/json' \
--header 'Content-Type: application/json' \
--header 'Authorization: Bearer eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJ0b2tlbl90eXBlIjoiYWNjZXNzIiwiZXhwIjoxNzI0Mzk2ODA1LCJpYXQiOjE3MjQzMTA0MDUsImp0aSI6IjQ4ZmM1YTIxNDNmODQ5MjdhZWY5YTZmZjlmOWU5ODZjIiwidXNlcl9pZCI6IjJkNWQxMTk5LTY4ZTUtNDMyMC1hMjEyLWM2ZjQ1NWU3ZDljYyIsImN1c3RvbV9jbGFpbSI6Ikg0c0lBSVhqeG1ZQy80MVh1WkxqTmhEOWxTbkZabGtIZFczbXhJbERPMGMxZ1NhRkZRaGdBVkFhemRiOHV4dWtKSkxpTVpPSmVOMUFINjhQL1Y1NDlGNGF6YVJZL0hoYnBBZWU4VndjazN5ZFk1S0NTSlBzdUJISkhuYmIvZUc0MysxVHZ2ampiU0U5QTFGS1RUckJWVWducGRHRnVkK3kyNjN5NDFMa1c3RmNiWFo4bGVmYmZMTmFZdFEwcmdBdFBZVDIwVTI2U3RQMWVwTmtKSldrcSsyYWZtMzN5WUducXd3UGgvMHl5Nk9xSUxWTUlRc08rRm5xZ25SelVENitqcnBHU3ZBdmdFTWZuT1FCQlpPV2JCWjBRQzZUaEs2VUlvRVBvekVhQVI5cGZNTVpGVDkvTDZxcU1XNjFQK3pTN1hxZHJMZTdkWkttUjBpeTFXR1pwSnNEN05JVTErbjJFQlhyY0VoNmpEeTdJTE5RSUFQTzZiVTJSaTh5cjNEbDBiSFNDSm5meGpHQkNzTlFMOW84cFZkakUzcStjaGU4VFIxUFhIaEhiWlVwNlU4RFdJQS9aUWFjbUVFbWJtNEZwaTdubFErbXBFRDhOSlhUMFViUUZPY1NkWmdSK3ZxV2NYc0djaE5oNUVZcDVNRzRBWUlsU01XbWNWLzZHZlI2Z3VEQjJoa1JzSElPcllSRXpYRkdKSmVvQk11Tm01WGl4TmM1K0lrNEpJSUxkSDVvaXdaMSs4REpjM3kzeG9VaGZkRmJvLzAwdlIvNFJHNmtEbGk0cHRrTW9nOEtmZVA2bkZoT2I1d0Urdk9zbERWWFlrb21aNFdDNUdjTTFLQm1rQWxIVzRFSlQxc0I3aEJJd0FjSWxmL0dTOVQvQzQzNHRhU29LTTR3K3pZb3hab3ZQODZpOGNPaXFlQkgwNjRQSCtaRmJGenRFWWxwaWE5Y2JGNnZVVGJSRGUvM2FCbjViZEVSWWFqcjhIR3FFWmRzbUVwaEt6QkQxa1pnV0dFNmwwWGxrQlVVL3lzTUw0ZkdEMG82eGVMdWlxK0tnc1lmTWRGL1MxNXFDc1FwakFxL1kyWVlEV0NPVGs4NUdQdE5ZTXE4MFBzekZoRlJNcHJ2TWRUVFZVTlpUOTMvbkFUMTluZUR2djFMYUx4SEtYTzlHOVc1dlQ1OURvbFg0TW5CVitBWjFVN1hnSnFzMXBuTy9nSzBKN3hUQlZ1andMWG4yblk4TEN0RmJPZ2QwVWYvSXE4a2RjQlhuZGZUWE1hNTdJRHEyUm43Y3A1Vklaak9ibVVwVlZkRGc1R1lqclROakNBbTJHNVg1R0FEUDBFL040WmR5QWpUWFNvZ2swcUdHd3VSSjkzWUVVWGhSa3RUNW9qc3B4NWtiRU1wWW9NbG9SYjRWVFZzR3lJVW9OS0VydjhYb016SGxhMnB2djRJdDA0YVIyWjF6UStHeUJQSFRLOHFpSEQwSUNoMkFRcHczWFc3YWRiQ2xQZGRzejFXeHRpZVF4eWN1OFVoZU8zeHFrNmNJc2tLVk1jMjJWZitWWmtBM1ZaWWR0MXNkZ2dXVHJTa2RCc21saFNnZ0lOdGcvSGhCc0k4ZDlMMjAxTVlVOFRneGVsSnpPOXRVUUh1MDdRWHFaOUd4aTRaRmFqc3U3eC9wM3psK1FqRW5mR2VCY2hHTUlmMXZQYjhoS0pTUTVmYnRhbFRHWlJrV2VLb0dkYWhvRFU5cnNYbnVHbzUrdVZHNUx6aDFERVlyWWNCZForV3BaWkVlYTJ4czNKTnJFcHpPMUl2YW1SRVF4OFl2WFIwZmVvWUs4Nmo5L2JXcWRGbHBkOThhZmUvU0k3ZmIvZmY2L1A5TjBxZ2ZENUwrS3NSTUlJUDB6dWNBd3BpT1JWMTcwZTl1QmZNNHovWVgxN0NuLzhZZFNZT1I0eHFSTmZqZ3Znc3FVVGo4aEhsRnArZi93T08wYVordVE0QUFBPT0ifQ.4h7MKol3jaNyuDU_jOwrSW4FiW-kiGTfnGBjAdbOLJc' \
--data '{
"survey_id":"9be04bc0-3e08-4f03-996e-315281bed083",
"data_structure": "flat",
"date_filter": {
"operand":["2024-01-01","2024-12-31"],
"type":"between"
},
"time_filter": {
"start": "2022-04-02 17:50:00",
"end": "2024-06-01 11:32:00"
},
"response_status": [0, 1, 2],
"collector_ids": ["dc22d6c3-7616-4ea9-a385-3b8fa7ac98f1"]
}' var data = JSON.stringify({
"survey_id": "9be04bc0-3e08-4f03-996e-315281bed083",
"data_structure": "flat",
"date_filter": {
"operand": [
"2024-01-01",
"2024-12-31"
],
"type": "between"
},
"time_filter": {
"start": "2022-04-02 17:50:00",
"end": "2024-06-01 11:32:00"
},
"response_status": [
0,
1,
2
],
"collector_ids": [
"dc22d6c3-7616-4ea9-a385-3b8fa7ac98f1"
]
});
var xhr = new XMLHttpRequest();
xhr.withCredentials = true;
xhr.addEventListener("readystatechange", function() {
if(this.readyState === 4) {
console.log(this.responseText);
}
});
xhr.open("POST", "https://az4-api.xebo.ai/api/v1/export/responses/json");
xhr.setRequestHeader("Content-Type", "application/json");
xhr.setRequestHeader("Authorization", "Bearer eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJ0b2tlbl90eXBlIjoiYWNjZXNzIiwiZXhwIjoxNzI0Mzk2ODA1LCJpYXQiOjE3MjQzMTA0MDUsImp0aSI6IjQ4ZmM1YTIxNDNmODQ5MjdhZWY5YTZmZjlmOWU5ODZjIiwidXNlcl9pZCI6IjJkNWQxMTk5LTY4ZTUtNDMyMC1hMjEyLWM2ZjQ1NWU3ZDljYyIsImN1c3RvbV9jbGFpbSI6Ikg0c0lBSVhqeG1ZQy80MVh1WkxqTmhEOWxTbkZabGtIZFczbXhJbERPMGMxZ1NhRkZRaGdBVkFhemRiOHV4dWtKSkxpTVpPSmVOMUFINjhQL1Y1NDlGNGF6YVJZL0hoYnBBZWU4VndjazN5ZFk1S0NTSlBzdUJISkhuYmIvZUc0MysxVHZ2ampiU0U5QTFGS1RUckJWVWducGRHRnVkK3kyNjN5NDFMa1c3RmNiWFo4bGVmYmZMTmFZdFEwcmdBdFBZVDIwVTI2U3RQMWVwTmtKSldrcSsyYWZtMzN5WUducXd3UGgvMHl5Nk9xSUxWTUlRc08rRm5xZ25SelVENitqcnBHU3ZBdmdFTWZuT1FCQlpPV2JCWjBRQzZUaEs2VUlvRVBvekVhQVI5cGZNTVpGVDkvTDZxcU1XNjFQK3pTN1hxZHJMZTdkWkttUjBpeTFXR1pwSnNEN05JVTErbjJFQlhyY0VoNmpEeTdJTE5RSUFQTzZiVTJSaTh5cjNEbDBiSFNDSm5meGpHQkNzTlFMOW84cFZkakUzcStjaGU4VFIxUFhIaEhiWlVwNlU4RFdJQS9aUWFjbUVFbWJtNEZwaTdubFErbXBFRDhOSlhUMFViUUZPY1NkWmdSK3ZxV2NYc0djaE5oNUVZcDVNRzRBWUlsU01XbWNWLzZHZlI2Z3VEQjJoa1JzSElPcllSRXpYRkdKSmVvQk11Tm01WGl4TmM1K0lrNEpJSUxkSDVvaXdaMSs4REpjM3kzeG9VaGZkRmJvLzAwdlIvNFJHNmtEbGk0cHRrTW9nOEtmZVA2bkZoT2I1d0Urdk9zbERWWFlrb21aNFdDNUdjTTFLQm1rQWxIVzRFSlQxc0I3aEJJd0FjSWxmL0dTOVQvQzQzNHRhU29LTTR3K3pZb3hab3ZQODZpOGNPaXFlQkgwNjRQSCtaRmJGenRFWWxwaWE5Y2JGNnZVVGJSRGUvM2FCbjViZEVSWWFqcjhIR3FFWmRzbUVwaEt6QkQxa1pnV0dFNmwwWGxrQlVVL3lzTUw0ZkdEMG82eGVMdWlxK0tnc1lmTWRGL1MxNXFDc1FwakFxL1kyWVlEV0NPVGs4NUdQdE5ZTXE4MFBzekZoRlJNcHJ2TWRUVFZVTlpUOTMvbkFUMTluZUR2djFMYUx4SEtYTzlHOVc1dlQ1OURvbFg0TW5CVitBWjFVN1hnSnFzMXBuTy9nSzBKN3hUQlZ1andMWG4yblk4TEN0RmJPZ2QwVWYvSXE4a2RjQlhuZGZUWE1hNTdJRHEyUm43Y3A1Vklaak9ibVVwVlZkRGc1R1lqclROakNBbTJHNVg1R0FEUDBFL040WmR5QWpUWFNvZ2swcUdHd3VSSjkzWUVVWGhSa3RUNW9qc3B4NWtiRU1wWW9NbG9SYjRWVFZzR3lJVW9OS0VydjhYb016SGxhMnB2djRJdDA0YVIyWjF6UStHeUJQSFRLOHFpSEQwSUNoMkFRcHczWFc3YWRiQ2xQZGRzejFXeHRpZVF4eWN1OFVoZU8zeHFrNmNJc2tLVk1jMjJWZitWWmtBM1ZaWWR0MXNkZ2dXVHJTa2RCc21saFNnZ0lOdGcvSGhCc0k4ZDlMMjAxTVlVOFRneGVsSnpPOXRVUUh1MDdRWHFaOUd4aTRaRmFqc3U3eC9wM3psK1FqRW5mR2VCY2hHTUlmMXZQYjhoS0pTUTVmYnRhbFRHWlJrV2VLb0dkYWhvRFU5cnNYbnVHbzUrdVZHNUx6aDFERVlyWWNCZForV3BaWkVlYTJ4czNKTnJFcHpPMUl2YW1SRVF4OFl2WFIwZmVvWUs4Nmo5L2JXcWRGbHBkOThhZmUvU0k3ZmIvZmY2L1A5TjBxZ2ZENUwrS3NSTUlJUDB6dWNBd3BpT1JWMTcwZTl1QmZNNHovWVgxN0NuLzhZZFNZT1I0eHFSTmZqZ3Znc3FVVGo4aEhsRnArZi93T08wYVordVE0QUFBPT0ifQ.4h7MKol3jaNyuDU_jOwrSW4FiW-kiGTfnGBjAdbOLJc");
xhr.send(data); Supported Filters
| Key | Type | Mandatory | Description |
| survey_id | string | Yes | Survey Id of the responses you want to export |
| data_structure | string (flat/nested) | Yes | Format of data in which you want to export the data. Can be flat (root-level key value pairs) or nested (having nested objects) |
| date_filter | object | No | Date filter object which is used as a filter. |
| time_filter | object | No | Date-time filter object which is used as a filter |
| response_status | array<integer>
(e.g. – [0, 1, 2] |
No | Response status filter
0 – Partial Responses 1 – Completed Responses 2 – Disqualified Responses |
| collector_ids | array<string> | No | Array of collector uuid’s |
Date Filter Examples
- Rolling Filter (e.g. Last 7 days, Last 3 months etc.)
{
amount: <Number>
period:”days/months/years”
type:”rolling”
}
- Before/After Time filter (e.g. before Nov 1st 2020, After July 15th 2020)
{
operand: [“yyyy-mm-dd”]
type: “before/after”
}
- Relative Time Filter (e.g. Today, This Month, Last Month, Previous Year)
{
amount: <Number>,
period: ‘days/months/years/weeks’,
type: “relative”
}
- Between Time Filter (e.g. between July 15th 2020 & Nov 1st 2020)
{
operand:[“yyyy-mm-dd”,”yyyy-mm-dd”] // from , to
type:”between”
}
Time Filter Examples
{
“start”: “2024-04-02 17:50:00”,
“end”: “2024-06-01 11:32:00”
}
Request Sample
Responses
{
"count": 1,
"results": [
{
"Respondent Unique Id": "2f8eddc9-75ef-4b71-8da7-b2e28b0c9188",
"Response Status": "Complete",
"Language": "en",
"Survey Name": "Feedback Survey",
"Survey Unique Id": "4c5f13cf-0952-4b2f-88d6-13c3e40874c6",
"Collector Name": "Web Link 1",
"Collector Unique Id": "301ce7fe-8d82-4991-be3f-664c68598f0a",
"Sent Date": "",
"Start Date": "2024-04-24 16:21:07",
"End Date": "2024-04-24 16:21:14",
"Time Duration": "0.15m",
"IP Address": "49.43.131.239, 13.235.7.153",
"Device Information": "Desktop",
"Device Type": "Chrome",
"OS Name": "Linux",
"Survey Version": 1,
"Location Latitude": "",
"Location Longitude": "",
"Country": "IN",
"City": "",
"Ticket(s) Generated": "",
"Verification Status": "",
"First Name": "",
"Last Name": "",
"Mobile": "",
"Email": "",
"External Unique Id": "",
"Please enter your age": "25-40",
"What is your favourite sport? - Cricket": "",
"What is your favourite sport? - Football": "Football",
"What is your favourite sport? - Hockey": "Hockey",
"What is your favourite sport? - Basketball": "",
"How likely is it that you would recommend our website to a friend or colleague?": "7"
}
],
"next": null,
"prev": null
} {
"count": 1,
"results": [
{
"respondentUniqueId": "7130246315",
"responseStatus": "Complete",
"language": "en",
"collectorUniqueId": "0b8cd754-648c-4fef-b835-a084b563b503",
"collectorName": "Test Link 1",
"sentDate": "",
"startDate": "2024-05-31 10:07:26",
"endDate": "2024-05-31 10:11:00",
"timeDuration": "3.74m",
"ipAddress": "",
"deviceInformation": "",
"deviceType": "Chrome",
"osName": "Linux",
"surveyVersion": 2,
"country": "",
"state": "",
"ticketsGenerated": [],
"surveyName": "All Types",
"surveyId": "28914019",
"answers": [
{
"questionName": "SC",
"questionType": "single_choice",
"answer": [
{
"rowId": "0e7d0f17-11de-4e55-99da-e57d8f10df80",
"rowText": "Option 2",
"value": "Option 2",
"weight": 2
}
]
},
{
"questionName": "MC",
"questionType": "multi_choice",
"answer": [
{
"rowId": "5a424e3a-9906-4631-bcce-440558601147",
"rowText": "Option 2",
"value": "Option 2",
"weight": 2
}
]
},
{
"questionName": "DROPDOWN",
"questionType": "dropdown",
"answer": [
{
"rowId": "20a16471-fd57-442c-b612-7fbbded38696",
"rowText": "Option 3",
"value": "Option 3",
"weight": 3
}
]
},
{
"questionName": "MUTLI DROPDOWN",
"questionType": "multi_select_dropdown",
"answer": [
{
"rowId": "88002a25-68be-4c0d-8dc2-7a55e83a2a1a",
"rowText": "Option 3",
"value": "Option 3",
"weight": 3
}
]
},
{
"questionName": "GABOR GRANGER",
"questionType": "gabor_granger",
"answer": [
{
"cycle": 1,
"rowId": "e60c17f5-59da-4097-b645-991b87b90dcf",
"value": "300",
"rowText": "Yes"
},
{
"cycle": 2,
"rowId": "e60c17f5-59da-4097-b645-991b87b90dcf",
"value": "400",
"rowText": "Yes"
},
{
"cycle": 3,
"rowId": "6fd441df-ff88-467a-84ac-89cd45474bc6",
"value": "500",
"rowText": "No"
}
]
},
{
"questionName": "DATE TIME",
"questionType": "date_time",
"answer": [
{
"rowId": "303ca418-95ae-4ed4-9a67-99b69e31ee10",
"text": "1,715,747,997,170",
"rowText": "Row 1",
"value": "2024-05-15 10:09:57"
}
]
}
],
"embedData": {
"email": "demo@xebo.ai",
"firstName": "Demo",
"lastName": "Xebo",
"mobile": "",
"externalUniqueId": "",
"verificationStatus": ""
},
"location": {
"latitude": "21.9974",
"longitude": "79.0011"
}
}
],
"next": null,
"previous": null
} {
"error": {
"status": 400,
"code": "invalid_payload",
"detail": {
"amount": [
"This field is required."
],
"period": [
"This field is required."
]
}
}
} {
"status": 401,
"code": "not_authorized",
"detail": "Authentication credentials were not provided"
}