Get Conversations

cursorstring nullable

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

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.

visited_agent_idsstring[] nullable

Filter conversations where any of these agents participated. Can not exceed 50 values.

visited_agent_branch_idsstring[] nullable

Filter conversations where any of these agent branches participated. Can not exceed 50 values.

call_successful'success' | 'failure' | 'unknown'

The result of the success evaluation

call_start_before_unixinteger nullable

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.

call_duration_min_secsinteger nullable

Minimum call duration in seconds.

call_duration_max_secsinteger nullable

Maximum call duration in seconds.

rating_maxinteger nullable

Maximum overall rating (1-5).

rating_mininteger nullable

Minimum overall rating (1-5).

has_feedback_commentboolean nullable

Filter conversations with user feedback comments.

user_idstring nullable

Filter conversations by the user ID who initiated them.

evaluation_paramsstring[] nullable

Evaluation filters. Repeat param. Format: criteria_id:result. Example: eval=value_framing:success

data_collection_paramsstring[] nullable

Data collection filters. Repeat param. Format: id:op:value where op is one of eq|neq|gt|gte|lt|lte|in|exists|missing. For in, pipe-delimit values.

data_collection_idsstring[] nullable

Data collection field IDs to include in each conversation summary. Repeat param. When omitted, data_collection_results is not returned.

evaluation_criteria_idsstring[] nullable

Evaluation criteria IDs to include in each conversation summary. Repeat param. When omitted, evaluation_criteria_results is not returned.

tool_namesstring[] nullable

Filter conversations by tool names used during the call.

tool_names_successfulstring[] nullable

Filter conversations by tool names that had successful calls.

tool_names_erroredstring[] nullable

Filter conversations by tool names that had errored calls.

main_languagesstring[] nullable

Filter conversations by detected main language (language code).

page_sizeinteger

How many conversations to return at maximum. Can not exceed 100, defaults to 30.

summary_mode'exclude' | 'include'

Whether to include transcript summaries in the response.

searchstring nullable

Full-text or fuzzy search over transcript messages

Enum representing the possible sources for conversation initiation.

text_onlyboolean nullable

conversation_product_type'agents' | 'speech_engine'

Which product surface owns this agent document.

Restrict results to a single conversation product surface.

branch_idstring nullable

Filter conversations by branch ID.

version_idstring nullable

Filter conversations by version ID.

parent_conversation_idstring nullable

Filter conversations by parent conversation ID for subagent conversations.

topic_idsstring[] nullable

Filter conversations by topic IDs assigned during topic discovery.

exclude_statusesstring[] nullable

Exclude conversations with the given statuses. Useful for hiding in-progress / processing conversations from list views.

tag_idsstring[] nullable

Filter conversations by conversation tag IDs assigned via the conversation-tags endpoints.

workflow_node_entered_idstring nullable

Filter conversations to only those that entered the given node.

termination_reasonsstring[] nullable

Filter conversations by their stored termination_reason (metadata.termination_reason). Repeat param to match any of several.

v5

Query parameters

Headers

Response