快速开始ConversationsTopics

Get agent conversation topics

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

路径参数

agent_idstring必需
ID of the agent

请求头

xi-api-keystring可选

查询参数

page_sizeinteger可选1-100

Number of top-level topic groups to return.

sort_byenum可选

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.

允许的值:
sort_directionenum可选
Direction to sort topics.
允许的值:
from_unix_secsinteger可选
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_secsinteger可选
End of the window to view topics for.
include_evaluation_criteriaboolean可选默认为 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.

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

响应

Successful Response
topicslist of objects
window_start_unix_secsinteger
window_end_unix_secsinteger
aggregated_run_countinteger可选默认为 0

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

has_moreboolean可选默认为 false
next_cursorstring可选

错误

422
Topics Get Request Unprocessable Entity Error