Get Agent Analytics Overview

Get
/api/v1/livechat/analytics/agent-overview

Get the analytics overview for the agents in your workspace. Permission required: view-livechat-manager

Changelog

Version Description
6.4.0 Added
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
name
stringRequired

The data that you want to get. The available options are:

  • Total_conversations
  • Avg_chat_duration
  • Total_messages
  • Avg_first_response_time
  • Best_first_response_time
  • Avg_response_time
  • Avg_reaction_time
from
stringRequired

The start date

Example2019-05-22T12:11:45.392Z
to
stringRequired

The end date

Example2023-05-22T12:11:45.392Z
departmentId
string

The department ID to return results for.

ExampleThe department ID to return results for.
Responses
200

OK

Success Example
{
  "head": [
    {
      "name": "Agent"
    },
    {
      "name": "Total_messages"
    }
  ],
  "data": [
    {
      "name": "kim",
      "value": "25"
    },
    {
      "name": "jane",
      "value": "50"
    },
    {
      "name": "baek",
      "value": "44"
    }
  ],
  "success": true
}
Expand All
object
head
Array of object
object
name
string
data
Array of object
object
name
string
value
string
success
boolean
400

Bad Request

Example 1
{
  "success": false,
  "error": "must have required property 'name' [invalid-params]",
  "errorType": "invalid-params"
}
Example 2
{
  "success": false,
  "error": "must have required property 'from' [invalid-params]",
  "errorType": "invalid-params"
}
Example 3
{
  "success": false,
  "error": "must have required property 'to' [invalid-params]",
  "errorType": "invalid-params"
}
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