Get Conversation by Agents
- Print
- DarkLight
- PDF
Get Conversation by Agents
- Print
- DarkLight
- PDF
Article summary
Did you find this summary helpful?
Thank you for your feedback
Get
/api/v1/livechat/analytics/dashboards/conversations-by-agent
View the metrics of omnichannel conversations in your workspace during a selected time range based on the agents in your workspace.
Permission required: view-livechat-reports
Changelog
| Version | Description |
|---|---|
| 6.4.0 | Added |
Header parameters
X-User-Id
stringRequired
The userId of the authenticated user.
ExamplerbAXPnMktTFbNpwtJ
X-Auth-Token
stringRequired
The authToken of the authenticated user.
ExampleRScctEHSmLGZGywfIhWyRpyofhKOiMoUIpimhvheU3f
Query parameters
start
stringRequired
The start date.
Example2020-09-10T23:59:22.345Z
end
stringRequired
The end date.
Example2020-09-09T00:11:22.345Z
Responses
200
OK
Success Example
{
"total": 51,
"data": [
{
"label": "9iN96PXnDK7XAYESA",
"value": 4
},
{
"label": "Dialog Bot",
"value": 1
},
{
"label": "Jane Kim",
"value": 15
},
{
"label": "Baek Kim",
"value": 1
},
{
"label": "agent5",
"value": 5
},
{
"label": "Rod",
"value": 5
},
{
"label": "User One",
"value": 6
},
{
"label": "oDCQTTquRFJWZtFxY",
"value": 1
},
{
"label": "sDNa65jXv4JaiGKQP",
"value": 1
},
{
"label": "testC",
"value": 12
}
],
"unspecified": 9,
"success": true
}object
total
integer
data
Array of object
object
label
string
value
integer
unspecified
integer
success
boolean
400
Bad Request
Example 1
{
"success": false,
"error": "must have required property 'start' [invalid-params]",
"errorType": "invalid-params"
}Example 2
{
"success": false,
"error": "The \"start\" query parameter must be a valid date."
}Example 3
{
"success": false,
"error": "must have required property 'end' [invalid-params]",
"errorType": "invalid-params"
}Example 4
{
"success": false,
"error": "The \"end\" query parameter must be a valid date."
}object
success
boolean
error
string
errorType
string
401
Unauthorized
Authorization Error
{
"status": "error",
"message": "You must be logged in to do this."
}object
status
string
message
string
403
Forbidden
Example 1
{
"success": false,
"error": "User does not have the permissions required for this action [error-unauthorized]"
}Example 2
{
"success": false,
"error": "unauthorized"
}object
success
boolean
error
string
Was this article helpful?