Analytics

get

Retrieves periodic responder chat message volume analytics.

Query parameters

granularitystring · enumRequiredPossible values:

rangeEndstring · date-time · nullableOptional

rangeStartstring · date-time · nullableOptional

Header parameters

authorizationstringRequired

The API key to use for authentication. Can be created in the api keys section on the workspace settings page.

Responses

200

Responder chat message volume analytics retrieved successfully.

application/json

channelIdstringRequired

channelNamestringRequired

channelTypestring · enumRequiredPossible values:

countintegerRequired

periodEndstring · date-timeRequired

periodStartstring · date-timeRequired

responderEntitystring · enumRequiredPossible values:

responderIdstringRequired

responderNamestringRequired

responderPicturestring · nullableRequired

401

Unauthorized.

application/json

get

/api/v1/analytics/periodic-responder-chat-message-volume

HTTPcURLJavaScriptPython

GET /api/v1/analytics/periodic-responder-chat-message-volume?granularity=hourly HTTP/1.1
Host: api.endless.zaia.app
authorization: text
Accept: */*

[
  {
    "channelId": "text",
    "channelName": "text",
    "channelType": "api",
    "count": 1,
    "periodEnd": "2026-06-11T20:42:52.563Z",
    "periodStart": "2026-06-11T20:42:52.563Z",
    "responderEntity": "agents",
    "responderId": "text",
    "responderName": "text",
    "responderPicture": "text"
  }
]

get

Retrieves periodic responder credit usage analytics.

Query parameters

granularitystring · enumRequiredPossible values:

rangeEndstring · date-time · nullableOptional

rangeStartstring · date-time · nullableOptional

Header parameters

authorizationstringRequired

The API key to use for authentication. Can be created in the api keys section on the workspace settings page.

Responses

200

Responder credit usage analytics retrieved successfully.

application/json

creditsnumberRequired

periodEndstring · date-timeRequired

periodStartstring · date-timeRequired

responderEntitystring · enumRequiredPossible values:

responderIdstringRequired

responderNamestringRequired

responderPicturestring · nullableRequired

401

Unauthorized.

application/json

get

/api/v1/analytics/periodic-responder-credit-usage

HTTPcURLJavaScriptPython

GET /api/v1/analytics/periodic-responder-credit-usage?granularity=hourly HTTP/1.1
Host: api.endless.zaia.app
authorization: text
Accept: */*

[
  {
    "credits": 1,
    "periodEnd": "2026-06-11T20:42:52.563Z",
    "periodStart": "2026-06-11T20:42:52.563Z",
    "responderEntity": "agents",
    "responderId": "text",
    "responderName": "text",
    "responderPicture": "text"
  }
]

get

Retrieves periodic user chat message average analytics.

Query parameters

granularitystring · enumRequiredPossible values:

rangeEndstring · date-time · nullableOptional

rangeStartstring · date-time · nullableOptional

Header parameters

authorizationstringRequired

The API key to use for authentication. Can be created in the api keys section on the workspace settings page.

Responses

200

User chat message average analytics retrieved successfully.

application/json

averagenumberRequired

channelIdstringRequired

channelNamestringRequired

channelTypestring · enumRequiredPossible values:

periodEndstring · date-timeRequired

periodStartstring · date-timeRequired

responderEntitystring · enumRequiredPossible values:

responderIdstringRequired

responderNamestringRequired

responderPicturestring · nullableRequired

401

Unauthorized.

application/json

get

/api/v1/analytics/periodic-user-chat-message-average

HTTPcURLJavaScriptPython

GET /api/v1/analytics/periodic-user-chat-message-average?granularity=hourly HTTP/1.1
Host: api.endless.zaia.app
authorization: text
Accept: */*

[
  {
    "average": 1,
    "channelId": "text",
    "channelName": "text",
    "channelType": "api",
    "periodEnd": "2026-06-11T20:42:52.563Z",
    "periodStart": "2026-06-11T20:42:52.563Z",
    "responderEntity": "agents",
    "responderId": "text",
    "responderName": "text",
    "responderPicture": "text"
  }
]

get

Retrieves periodic user interactivity analytics.

Query parameters

granularitystring · enumRequiredPossible values:

rangeEndstring · date-time · nullableOptional

rangeStartstring · date-time · nullableOptional

Header parameters

authorizationstringRequired

The API key to use for authentication. Can be created in the api keys section on the workspace settings page.

Responses

200

User interactivity analytics retrieved successfully.

application/json

channelIdstringRequired

channelNamestringRequired

channelTypestring · enumRequiredPossible values:

countintegerRequired

periodEndstring · date-timeRequired

periodStartstring · date-timeRequired

401

Unauthorized.

application/json

get

/api/v1/analytics/periodic-user-interactivity

HTTPcURLJavaScriptPython

GET /api/v1/analytics/periodic-user-interactivity?granularity=hourly HTTP/1.1
Host: api.endless.zaia.app
authorization: text
Accept: */*

[
  {
    "channelId": "text",
    "channelName": "text",
    "channelType": "api",
    "count": 1,
    "periodEnd": "2026-06-11T20:42:52.563Z",
    "periodStart": "2026-06-11T20:42:52.563Z"
  }
]