Sign in

v4

OpenAPI 3.1.02026-07-313621,3961.8 MB
Agents Platform

Get Conversation Users

Get distinct users from conversations with pagination.

get/v1/convai/users

Query parameters

agent_idstring nullable

Agent id (agent_…) or speech engine external id (seng_), resolved to the same underlying resource.

Example:agent_3701k3ttaq12ewp8b7qv5rfyszkz

Agent id (agent_…) or speech engine external id (seng_), resolved to the same underlying resource.

branch_idstring nullable

Filter conversations by branch ID.

Filter conversations by branch ID.

call_start_before_unixinteger nullable

Unix timestamp (in seconds) to filter conversations up to this start date.

Unix timestamp (in seconds) to filter conversations up to this start date.

call_start_after_unixinteger nullable

Unix timestamp (in seconds) to filter conversations after to this start date.

Unix timestamp (in seconds) to filter conversations after to this start date.

searchstring nullable

Search/filter by user ID (exact match).

Search/filter by user ID (exact match).

page_sizeinteger

How many users to return at maximum. Defaults to 30.

How many users to return at maximum. Defaults to 30.

sort_by'last_contact_unix_secs' | 'conversation_count' | 'average_sentiment_score'

The field to sort the results by. Defaults to last_contact_unix_secs.

sort_direction'asc' | 'desc'

The direction to sort the results

cursorstring nullable

Used for fetching next page. Cursor is returned in the response.

Used for fetching next page. Cursor is returned in the response.

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

next_cursorstring nullable
has_moreboolean required