Skip to navigation
API referenceConversationsTopics

Get agent conversation topics

Returns the latest topic discovery run results for a given agent.

Path parameters

agent_idstringRequired
ID of the agent

Headers

xi-api-keystringOptional

Query parameters

page_sizeintegerOptional1-100

Number of top-level topic groups to return.

sort_byenumOptional

Column to rank topics by. Use conversations for volume, sentiment with sort_direction=asc for the most negative topics, and frustration with sort_direction=desc for the most frustrated ones. Topics with no score are always ranked last.

Allowed values:
sort_directionenumOptional
Direction to sort topics.
Allowed values:
from_unix_secsintegerOptional

Start of the window to view topics for. When set with to_unix_secs, the completed daily topic-discovery runs in the range are aggregated together, so the window scopes the metrics as well as the topic set. Floored to the start of its UTC day because runs cover whole UTC days; aggregated_run_count reports how many runs were summed. Omit both bounds to get the single latest run.

to_unix_secsintegerOptional
End of the window to view topics for.
include_evaluation_criteriabooleanOptionalDefaults to true

Include the per-criteria evaluation breakdown on each topic’s metrics. Pass false to drop it: it dominates the payload and the weighted success_rate is returned either way.

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

Response

Successful Response
topicslist of objects
window_start_unix_secsinteger
window_end_unix_secsinteger
aggregated_run_countintegerOptionalDefaults to 0

Number of daily topic-discovery runs the returned metrics were summed over.

has_morebooleanOptionalDefaults to false
next_cursorstringOptional

Errors

422
Topics Get Request Unprocessable Entity Error