Sign in

v7

latestOpenAPI 3.1.02026-08-08356409701.0 KB
Observability Conversations

Query Observability Conversations

Query production conversations for this organization.

Omit group_by for rows, newest first. Set it for counts per group: by status, agent, label, day, interface, direction, ended_by, a metadata_path, or metric_value for how a metric came out. Filters apply either way, so one narrowing answers both "show me" and "how many".

get/v1/observability/conversations

Query parameters

statusstring[] nullable

e.g. COMPLETED, SYSTEM_ERROR

e.g. COMPLETED, SYSTEM_ERROR

agent_idsinteger[] nullable
label_idsstring[] nullable
initiation_directionstring[] nullable

inbound, outbound

inbound, outbound

caller_numberstring nullable

E.164

E.164

duration_mininteger nullable

Minimum duration in ms

Minimum duration in ms

duration_maxinteger nullable

Maximum duration in ms

Maximum duration in ms

tagsstring[] nullable
conversation_idsstring[] nullable
interfacestring[] nullable
labelstring nullable

Label text, resolved to an id

Label text, resolved to an id

metadata_pathstring nullable

Metadata key, e.g. restaurant_code

Metadata key, e.g. restaurant_code

metadata_valuestring nullable
metric_namestring nullable

Required when group_by is metric_value

Required when group_by is metric_value

metric_idstring uuid nullable
metric_valuestring[] nullable

Keep only conversations whose metric came out one of these values. Needs metric_name or metric_id. This is the filter, not the grouping.

Keep only conversations whose metric came out one of these values. Needs metric_name or metric_id. This is the filter, not the grouping.

metric_minnumber nullable

Numeric metrics: keep results at or above this

Numeric metrics: keep results at or above this

metric_maxnumber nullable

Numeric metrics: keep results at or below this

Numeric metrics: keep results at or below this

group_by'status' | 'agent' | 'label' | 'day' | 'interface' | 'direction' | 'ended_by' | 'metadata' | 'metric_value' nullable

Omit for rows; set for counts

Omit for rows; set for counts

last'1day' | '3days' | '7days' | '30days' | '90days' | 'all'
sort_order'asc' | 'desc'
page_sizeinteger
pageinteger

Headers

X-API-Keystring required

API key required to authenticate requests.

Response

Successful Response

totalinteger required

Everything matching the filters, not just this page

group_bystring nullable
groups_truncatedboolean

True when more groups matched than were returned

metric_namestring nullable
metric_typestring nullable
not_applicableinteger nullable
averagenumber nullable

Numeric metrics only

pageinteger nullable
page_sizeinteger nullable
unreadable_skippedinteger

Rows on this page too incomplete to read, dropped rather than failing it