Skip to main content
GET
Get Agent Conversation Topics

Headers

x-api-key
string | null

Your API key for programmatic access. Send it in the x-api-key header; you can create and manage keys from the Developers page.

Path Parameters

agent_id
string
required

ID of the agent

Query Parameters

page_size
integer | null

Number of top-level topic groups to return.

Required range: 1 <= x <= 100
sort_by
enum<string>
default:conversations

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.

Available options:
conversations,
sentiment,
success_rate,
frustration
sort_direction
enum<string>
default:desc

Direction to sort topics.

Available options:
asc,
desc
from_unix_secs
integer | null

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_secs
integer | null

End of the window to view topics for.

include_evaluation_criteria
boolean
default: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.

cursor
string | null

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

Response

Successful Response

topics
AgentTopicResponseModel · object[]
required
window_start_unix_secs
integer
required
window_end_unix_secs
integer
required
aggregated_run_count
integer
default:0

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

has_more
boolean
default:false
next_cursor
string | null