ComeçarConversationsTopics

Get agent conversation topics

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

Parâmetros de caminho

agent_idstringObrigatório
ID of the agent

Cabeçalhos

xi-api-keystringOpcional

Parâmetros de consulta

page_sizeintegerOpcional1-100

Number of top-level topic groups to return.

sort_byenumOpcional

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.

Valores permitidos:
sort_directionenumOpcional
Direction to sort topics.
Valores permitidos:
from_unix_secsintegerOpcional
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_secsintegerOpcional
End of the window to view topics for.
include_evaluation_criteriabooleanOpcionalPadrão é 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.

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

Resposta

Successful Response
topicslist of objects
window_start_unix_secsinteger
window_end_unix_secsinteger
aggregated_run_countintegerOpcionalPadrão é 0

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

has_morebooleanOpcionalPadrão é false
next_cursorstringOpcional

Erros

422
Topics Get Request Unprocessable Entity Error