Ir para a navegação

Obter tópicos da conversa do agente

Retorna os resultados da execução mais recente de descoberta de tópicos para um determinado agente.

Parâmetros de caminho

agent_idstringObrigatório
ID do agente

Cabeçalhos

xi-api-keystringOpcional

Parâmetros de consulta

page_sizeintegerOpcional1-100

Número de grupos de tópicos de nível superior a retornar.

sort_byenumOpcional

Coluna usada para classificar os tópicos. Use conversations para volume, sentiment com sort_direction=asc para os tópicos mais negativos e frustration com sort_direction=desc para os mais frustrantes. Tópicos sem pontuação sempre ficam por último.

Valores permitidos:
sort_directionenumOpcional

Direção para ordenar tópicos.

Valores permitidos:
from_unix_secsintegerOpcional

Início da janela para visualizar tópicos. Quando definido com to_unix_secs, as execuções diárias concluídas de descoberta de tópicos no intervalo são agregadas, portanto a janela delimita tanto as métricas quanto o conjunto de tópicos. É ajustado para o início do dia UTC correspondente, pois as execuções abrangem dias UTC inteiros; aggregated_run_count informa quantas execuções foram somadas. Omita ambos os limites para obter somente a execução mais recente.

to_unix_secsintegerOpcional

Fim da janela para visualizar tópicos.

include_evaluation_criteriabooleanOpcionalPadrão é true

Inclua a divisão da avaliação por critério nas métricas de cada tópico. Passe false para removê-la: ela representa a maior parte do payload, e a success_rate ponderada é retornada de qualquer forma.

cursorstringOpcional

Usado para buscar a próxima página. O cursor é retornado na resposta.

Resposta

Resposta bem-sucedida

topicslist of objects
window_start_unix_secsinteger
window_end_unix_secsinteger
aggregated_run_countintegerOpcionalPadrão é 0

Número de execuções diárias de descoberta de tópicos usadas para somar as métricas retornadas.

has_morebooleanOpcionalPadrão é false
next_cursorstringOpcional

Erros

422
Topics Get Request Unprocessable Entity Error