Get Agent Analytics Overview

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

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

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
400
401
403

OK

Collapse all
object
head
Array of object
object
name
string
data
Array of object
object
success
boolean