Sign in
OpenAPI 3.1.02026-08-193781,4532.0 MB

4bbf59c13c42

Agents Platform

Get Live Count

Get the live count of the ongoing conversations.

get/v1/convai/analytics/live-count

Query parameters

agent_idstring nullable

The id of an agent to restrict the analytics to.

Example:21m00Tcm4TlvDq8ikWAM

The id of an agent to restrict the analytics to.

agent_idsstring[] nullable

Restrict analytics to the union of the given agents. Takes precedence over agent_id when both are supplied.

Restrict analytics to the union of the given agents. Takes precedence over agent_id when both are supplied.

[
  "21m00Tcm4TlvDq8ikWAM"
]

Headers

xi-api-keystring nullable

Your API key. This is required by most endpoints to access our API programmatically. You can view your xi-api-key using the 'Profile' tab on the website.

Your API key. This is required by most endpoints to access our API programmatically. You can view your xi-api-key using the 'Profile' tab on the website.

Response

Successful Response

countinteger required

The number of active ongoing conversations.

Example response

{
  "count": 42
}