Customer Surveys
Handle data related to ImBox Customer Surveys.
grabSurvey
Get a single survey with ticketId or callId.
Parameters
| Name | Type | Description |
|---|---|---|
| apiKey* | String | Your API key |
Query parameters
| Name | Type | Description |
|---|---|---|
| ticketId* | String | Id for ticket |
| callId* | String | Id for call |
Usage
curl -X GET "https://apiv2.imbox.io/api/grabSurvey/:apiKey?ticketId=123
Response
{
"agentId": 12,
"ticketId": 123, // If fetched with callId, ticketId will be replaced with callId.
"surveySetupId": 1,
"ratingScale": "1-10",
"rating": 8,
"createdAt": "2025-03-25T19:01:33.000Z",
"completedAt": "2025-03-26T13:01:55.000Z",
"versionId": 45,
"data": [
{ "question": "Please rate your customer experience", "answer": "8" },
{ "question": "Anything else?", "answer": "Yes it was a very nice woman I talked to!" }
]
}
API key scope access
Configure API key access in ImBox Admin dashboard.
| Scope | Access |
|---|---|
| Customer Survey | Read |