Get agent analytics

Get agent analytics

curl --request GET \
  --url https://app.livechatai.com/api/v2/analytics/agent \
  --header 'Authorization: Bearer <token>'

{
  "status": "success",
  "data": {
    "currentPeriod": {
      "totalConversationCount": 45,
      "closedConversationCount": 38,
      "agentResponseTime": 1250,
      "avarageMessagesPerConversation": 8.5,
      "averageAgentCSATScore": 4.2,
      "totalAgentCSATResponses": 28,
      "changes": {
        "totalConversationCount": 12.5,
        "closedConversationCount": 8.3,
        "agentResponseTime": -5.2,
        "avarageMessagesPerConversation": 3.7,
        "averageAgentCSATScore": 4.1
      }
    },
    "previousPeriod": {
      "totalConversationCount": 40,
      "closedConversationCount": 35,
      "agentResponseTime": 1318,
      "avarageMessagesPerConversation": 8.2,
      "averageAgentCSATScore": 4,
      "totalAgentCSATResponses": 25
    }
  }
}

GET

api

analytics

agent

Get agent analytics

curl --request GET \
  --url https://app.livechatai.com/api/v2/analytics/agent \
  --header 'Authorization: Bearer <token>'

{
  "status": "success",
  "data": {
    "currentPeriod": {
      "totalConversationCount": 45,
      "closedConversationCount": 38,
      "agentResponseTime": 1250,
      "avarageMessagesPerConversation": 8.5,
      "averageAgentCSATScore": 4.2,
      "totalAgentCSATResponses": 28,
      "changes": {
        "totalConversationCount": 12.5,
        "closedConversationCount": 8.3,
        "agentResponseTime": -5.2,
        "avarageMessagesPerConversation": 3.7,
        "averageAgentCSATScore": 4.1
      }
    },
    "previousPeriod": {
      "totalConversationCount": 40,
      "closedConversationCount": 35,
      "agentResponseTime": 1318,
      "avarageMessagesPerConversation": 8.2,
      "averageAgentCSATScore": 4,
      "totalAgentCSATResponses": 25
    }
  }
}

Authorizations

Authorization

string

header

required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Query Parameters

agentId

string

required

The ID of the agent/chatbot

Example:

"clx1234567890abcdef"

startDate

string<date>

required

Start date for analytics (ISO 8601 format)

Example:

"2024-01-01"

endDate

string<date>

required

End date for analytics (ISO 8601 format)

Example:

"2024-01-31"

userId

string

Optional specific agent/user ID to filter analytics

Example:

"user_1234567890"

timezone

string

Timezone for date calculations (defaults to system timezone)

Example:

"America/New_York"

Response

Successfully retrieved agent analytics data

status

string

Example:

"success"

data

object

Show child attributes

data.currentPeriod

object

Show child attributes

data.currentPeriod.totalConversationCount

number

Total number of conversations in the current period

Example:

45

data.currentPeriod.closedConversationCount

number

Number of closed conversations in the current period

Example:

38

data.currentPeriod.agentResponseTime

number

Average agent response time in seconds

Example:

1250

data.currentPeriod.avarageMessagesPerConversation

number

Average number of messages per conversation

Example:

8.5

data.currentPeriod.averageAgentCSATScore

number | null

Average human agent CSAT score (1-5 scale), null if no responses

Example:

4.2

data.currentPeriod.totalAgentCSATResponses

number

Total number of human agent CSAT responses received

Example:

28

data.currentPeriod.changes

object

Percentage changes compared to previous period

Show child attributes

data.currentPeriod.changes.totalConversationCount

number

Percentage change in total conversations

Example:

12.5

data.currentPeriod.changes.closedConversationCount

number

Percentage change in closed conversations

Example:

8.3

data.currentPeriod.changes.agentResponseTime

number

Percentage change in response time (negative means faster)

Example:

-5.2

data.currentPeriod.changes.avarageMessagesPerConversation

number | null

Percentage change in average messages per conversation

Example:

3.7

data.currentPeriod.changes.averageAgentCSATScore

number | null

Percentage change in average agent CSAT score

Example:

4.1

data.previousPeriod

object

Previous period data for comparison

Show child attributes

data.previousPeriod.totalConversationCount

number

Total number of conversations in the previous period

Example:

40

data.previousPeriod.closedConversationCount

number

Number of closed conversations in the previous period

Example:

35

data.previousPeriod.agentResponseTime

number

Average agent response time in seconds in the previous period

Example:

1318

data.previousPeriod.avarageMessagesPerConversation

number

Average number of messages per conversation in the previous period

Example:

8.2

data.previousPeriod.averageAgentCSATScore

number | null

Average human agent CSAT score in previous period (1-5 scale), null if no responses

Example:

4

data.previousPeriod.totalAgentCSATResponses

number

Total number of human agent CSAT responses in previous period

Example:

25

Get main analytics Get AI function analytics

⌘I

API v2 Documentation

Agents

Conversations

Contacts

Data Sources

Analytics

Authorizations

Query Parameters

Response