Resumo de resultados de um período
A leitura comercial agregada de um cliente num período: totais, o funil de ligações, os desfechos, os status que os agentes disseram e os que poderiam ter dito, as respostas às perguntas do cliente, a série no tempo e o custo por desfecho — com cost_per_won_micros, o custo de cada venda. Tudo é contado sobre o período inteiro, não sobre uma página. tenant_id é obrigatório para quem alcança mais de um cliente (422): vocabulários e custos são por cliente. agent_id estreita a um agente de voz ou de texto; sem ele, os agentes são comparados pelo eixo comum. O custo é só de ligação, e null numa leitura de texto. Valores em milionésimos de dólar.
Autorização
bearer results:readCredencial da v3: o JWT da sessão (o mesmo da v2) ou um token pessoal dom_pat_…. A lista de escopos de cada operação diz o que ela exige: uma capacidade (agents:read), authenticated ou session-only. Segredo de máquina (X-Agent-Secret, X-API-Token, sdk_…) não é aceito.
Em: header
Escopo: results:read
Parâmetros de consulta
Obrigatório para quem alcança mais de um cliente: vocabulários e custos são por cliente.
int64Um agente de voz ou de texto do cliente; omitido, o cliente todo.
uuidvoice ou text; omitido, os dois.
Valor em
- "voice"
- "text"
Primeiro dia (horário de Brasília), AAAA-MM-DD. Padrão: 29 dias antes de to.
Último dia, inclusive. Padrão: hoje.
day (padrão) ou week.
Valor em
- "day"
- "week"
Corpo da resposta
application/json
application/json
curl -X GET "https://example.com/results/summary"{ "by_channel": [ { "advanced": 0, "channel": "string", "classified": 0, "interactions": 0, "won": 0 } ], "by_classified_by": [ { "classified_by": "string", "count": 0 } ], "by_facet": [ { "by_outcome": { "property1": 0, "property2": 0 }, "count": 0, "facet": "string", "value": "string" } ], "by_outcome": [ { "count": 0, "outcome": "string" } ], "by_period": [ { "bucket": "string", "by_outcome": { "property1": 0, "property2": 0 }, "total": 0 } ], "by_purpose": [ { "advanced": 0, "classified": 0, "interactions": 0, "purpose": "string", "won": 0 } ], "by_status": [ { "agent_id": "2b1e3b65-2c04-4fa2-a2d7-467901e98978", "agent_name": "string", "agent_status": "string", "agent_status_label": "string", "channel": "string", "count": 0, "outcome": "string", "purpose": "string" } ], "copilot_excluded": 0, "cost": null, "declared_statuses": [ { "count": 0, "declared": true, "label": "string", "outcome": "string", "purpose": "string", "status": "string", "success": true } ], "facet_values_seen": { "property1": 0, "property2": 0 }, "funnel": null, "range": { "bucket": "string", "from": "string", "timezone": "string", "to": "string" }, "scope": { "agent_id": "2b1e3b65-2c04-4fa2-a2d7-467901e98978", "channel": "string", "tenant_id": 0 }, "studio_excluded": 0, "text_closer": null, "totals": { "answered": 0, "classified": 0, "conversed": 0, "interactions": 0, "unclassified": 0 }}