Get main analytics

Get main analytics

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

{
  "status": "success",
  "data": {
    "currentPeriod": {
      "totalConversationCount": 150,
      "openConversationCount": 25,
      "closedConversationCount": 125,
      "totalResolutionCount": 120,
      "agentJoinedConversationRate": 15,
      "averageResolutionRate": 80,
      "totalGoodResponse": 95,
      "totalBadResponse": 25,
      "goodResponseRate": 79,
      "badResponseRate": 21,
      "totalContactsCapture": 45,
      "averageChatDuration": 325,
      "humanizedAverageChatDuration": "5m 25s",
      "averageAIAgentCSATScore": 4.5,
      "totalAIAgentCSATResponses": 32,
      "dailyData": [
        {
          "date": "2024-01-15",
          "total": 10,
          "aiResolved": 8,
          "humanInvolved": 2
        }
      ],
      "changes": {
        "totalConversationCount": 10.5,
        "closedConversationCount": 12.3,
        "totalResolutionCount": 8.3,
        "agentJoinedConversationRate": -12.5,
        "averageResolutionRate": 5.2,
        "goodResponseRate": 8.7,
        "badResponseRate": -3.1,
        "totalContactsCapture": 15.8,
        "averageChatDuration": -3.5,
        "averageAIAgentCSATScore": 3.2
      }
    },
    "previousPeriod": {
      "totalConversationCount": 136,
      "openConversationCount": 20,
      "closedConversationCount": 111,
      "totalResolutionCount": 105,
      "agentJoinedConversationRate": 13,
      "averageResolutionRate": 76,
      "totalGoodResponse": 82,
      "totalBadResponse": 30,
      "goodResponseRate": 73,
      "badResponseRate": 27,
      "totalContactsCapture": 39,
      "averageChatDuration": 337,
      "humanizedAverageChatDuration": "5m 37s",
      "averageAIAgentCSATScore": 4.3,
      "totalAIAgentCSATResponses": 28
    }
  }
}

GET

api

analytics

Get main analytics

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

{
  "status": "success",
  "data": {
    "currentPeriod": {
      "totalConversationCount": 150,
      "openConversationCount": 25,
      "closedConversationCount": 125,
      "totalResolutionCount": 120,
      "agentJoinedConversationRate": 15,
      "averageResolutionRate": 80,
      "totalGoodResponse": 95,
      "totalBadResponse": 25,
      "goodResponseRate": 79,
      "badResponseRate": 21,
      "totalContactsCapture": 45,
      "averageChatDuration": 325,
      "humanizedAverageChatDuration": "5m 25s",
      "averageAIAgentCSATScore": 4.5,
      "totalAIAgentCSATResponses": 32,
      "dailyData": [
        {
          "date": "2024-01-15",
          "total": 10,
          "aiResolved": 8,
          "humanInvolved": 2
        }
      ],
      "changes": {
        "totalConversationCount": 10.5,
        "closedConversationCount": 12.3,
        "totalResolutionCount": 8.3,
        "agentJoinedConversationRate": -12.5,
        "averageResolutionRate": 5.2,
        "goodResponseRate": 8.7,
        "badResponseRate": -3.1,
        "totalContactsCapture": 15.8,
        "averageChatDuration": -3.5,
        "averageAIAgentCSATScore": 3.2
      }
    },
    "previousPeriod": {
      "totalConversationCount": 136,
      "openConversationCount": 20,
      "closedConversationCount": 111,
      "totalResolutionCount": 105,
      "agentJoinedConversationRate": 13,
      "averageResolutionRate": 76,
      "totalGoodResponse": 82,
      "totalBadResponse": 30,
      "goodResponseRate": 73,
      "badResponseRate": 27,
      "totalContactsCapture": 39,
      "averageChatDuration": 337,
      "humanizedAverageChatDuration": "5m 37s",
      "averageAIAgentCSATScore": 4.3,
      "totalAIAgentCSATResponses": 28
    }
  }
}

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"

timezone

string

Timezone for date calculations (defaults to system timezone)

Example:

"America/New_York"

Response

Successfully retrieved 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

Example:

150

data.currentPeriod.openConversationCount

number

Number of open conversations

Example:

25

data.currentPeriod.closedConversationCount

number

Number of closed conversations

Example:

125

data.currentPeriod.totalResolutionCount

number

Total number of resolutions

Example:

120

data.currentPeriod.agentJoinedConversationRate

number

Percentage of conversations where an agent joined

Example:

15

data.currentPeriod.averageResolutionRate

number

Average resolution rate percentage

Example:

80

data.currentPeriod.totalGoodResponse

number

Total number of positive responses

Example:

95

data.currentPeriod.totalBadResponse

number

Total number of negative responses

Example:

25

data.currentPeriod.goodResponseRate

number

Percentage of positive responses

Example:

79

data.currentPeriod.badResponseRate

number

Percentage of negative responses

Example:

21

data.currentPeriod.totalContactsCapture

number

Total number of contacts captured

Example:

45

data.currentPeriod.averageChatDuration

number

Average chat duration in seconds

Example:

325

data.currentPeriod.humanizedAverageChatDuration

string

Human-readable average chat duration

Example:

"5m 25s"

data.currentPeriod.averageAIAgentCSATScore

number | null

Average AI Agent CSAT score (1-5 scale), null if no responses

Example:

4.5

data.currentPeriod.totalAIAgentCSATResponses

number

Total number of AI Agent CSAT responses received

Example:

32

data.currentPeriod.dailyData

object[]

Daily breakdown of conversation data

Show child attributes

data.currentPeriod.dailyData.date

string

Date of the data point

Example:

"2024-01-15"

data.currentPeriod.dailyData.total

number

Total conversations for this day

Example:

10

data.currentPeriod.dailyData.aiResolved

number

Number of AI-resolved conversations

Example:

8

data.currentPeriod.dailyData.humanInvolved

number

Number of conversations with human involvement

Example:

2

data.currentPeriod.changes

object

Percentage changes compared to previous period

Show child attributes

data.currentPeriod.changes.totalConversationCount

number

Percentage change in total conversations

Example:

10.5

data.currentPeriod.changes.closedConversationCount

number | null

Percentage change in closed conversations

Example:

12.3

data.currentPeriod.changes.totalResolutionCount

number | null

Percentage change in resolutions

Example:

8.3

data.currentPeriod.changes.agentJoinedConversationRate

number | null

Percentage change in agent joined conversation rate

Example:

-12.5

data.currentPeriod.changes.averageResolutionRate

number

Percentage change in resolution rate

Example:

5.2

data.currentPeriod.changes.goodResponseRate

number | null

Percentage change in positive response rate

Example:

8.7

data.currentPeriod.changes.badResponseRate

number | null

Percentage change in bad response rate

Example:

-3.1

data.currentPeriod.changes.totalContactsCapture

number

Percentage change in contacts captured

Example:

15.8

data.currentPeriod.changes.averageChatDuration

number | null

Percentage change in average chat duration

Example:

-3.5

data.currentPeriod.changes.averageAIAgentCSATScore

number | null

Percentage change in average AI Agent CSAT score

Example:

3.2

data.previousPeriod

object

Previous period data for comparison

Show child attributes

data.previousPeriod.totalConversationCount

number

Total conversations in previous period

Example:

136

data.previousPeriod.openConversationCount

number

Number of open conversations in previous period

Example:

20

data.previousPeriod.closedConversationCount

number

Closed conversations in previous period

Example:

111

data.previousPeriod.totalResolutionCount

number

Total number of resolutions in previous period

Example:

105

data.previousPeriod.agentJoinedConversationRate

number

Percentage of conversations where an agent joined in previous period

Example:

13

data.previousPeriod.averageResolutionRate

number

Resolution rate in previous period

Example:

76

data.previousPeriod.totalGoodResponse

number

Total number of positive responses in previous period

Example:

82

data.previousPeriod.totalBadResponse

number

Total number of negative responses in previous period

Example:

30

data.previousPeriod.goodResponseRate

number

Positive response rate in previous period

Example:

73

data.previousPeriod.badResponseRate

number

Percentage of negative responses in previous period

Example:

27

data.previousPeriod.totalContactsCapture

number

Total number of contacts captured in previous period

Example:

39

data.previousPeriod.averageChatDuration

number

Average chat duration in seconds in previous period

Example:

337

data.previousPeriod.humanizedAverageChatDuration

string

Human-readable average chat duration in previous period

Example:

"5m 37s"

data.previousPeriod.averageAIAgentCSATScore

number | null

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

Example:

4.3

data.previousPeriod.totalAIAgentCSATResponses

number

Total number of AI Agent CSAT responses in previous period

Example:

28

Delete data sources Get agent analytics

⌘I

API v2 Documentation

Agents

Conversations

Contacts

Data Sources

Analytics

Authorizations

Query Parameters

Response