Get Agent Service Time Metrics

Prev Next
Get
/api/v1/livechat/analytics/dashboards/agents-productivity-totalizers

Permission required: view-livechat-manager

Header parameters
X-Auth-Token
stringRequired

The authToken of the authenticated user.

ExampleRScctEHSmLGZGywfIhWyRpyofhKOiMoUIpimhvheU3f
X-User-Id
stringRequired

The userId of the authenticated user.

ExamplerbAXPnMktTFbNpwtJ
Query parameters
start
stringRequired

The start date.

Example2020-09-10T23:59:22.345Z
end
stringRequired

The end date.

Example2020-09-09T00:11:22.345Z
departmentId
string

The department ID.

Responses
200

OK

Success Example
{
  "totalizers": [
    {
      "title": "Busiest_time",
      "value": "9AM- 10AM"
    },
    {
      "title": "Avg_of_available_service_time",
      "value": "00:45:18"
    },
    {
      "title": "Avg_of_service_time",
      "value": "00:06:00"
    }
  ],
  "success": true
}
Expand All
object
totalizers
Array of object
object
title
string
value
string
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

Permission Error
{
  "success": false,
  "error": "User does not have the permissions required for this action [error-unauthorized]"
}
Unauthorized
{
  "success": false,
  "error": "unauthorized"
}
object
success
boolean
error
string