Get Agent Total Service Time

Prev Next
Get
/api/v1/livechat/analytics/agents/total-service-time
Premium tag

Gives the total service time sorted by agent. Permission required: view-livechat-manager

Service time means how long time the agent is online and available. It does not mean how long time the agent was busy answering chats.

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
offset
integer

Number of items to "skip" in the query, i.e. requests return count items, skipping the first offset items. Refer to the official documentation to learn more.

Example50
count
integer

The number of items to return. Refer to the official documentation to learn more.

Example25
Responses
200

OK

Success Example
{
  "agents": [
    {
      "chats": 3,
      "_id": "rbAXPnMktTFbNpwtJ",
      "username": "kim.baeko",
      "serviceTimeDuration": 331
    },
    {
      "chats": 4,
      "_id": "CkCPNcvsvCDfmWLqC",
      "username": "han.jun",
      "serviceTimeDuration": 823
    },
    {
      "chats": 4,
      "_id": "CkCPNcvsvCDfmWLqC",
      "username": "doe.john",
      "serviceTimeDuration": 333
    }
  ],
  "count": 3,
  "offset": 0,
  "total": 3,
  "success": true
}
Expand All
object
agents
Array of object
object
chats
integer
_id
string
username
string
serviceTimeDuration
integer
count
integer
offset
integer
total
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

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
Tags