ZapyFlow/Documentação da APIopenapi.json

Analytics

Metricas e relatorios

GET/api/analytics/ai-agents

Performance por agente de IA no periodo

Escopo exigido: analytics.read

ParâmetroOndeObrigatório
fromquerysim
toquerysim
bash
curl "https://api.zapyflow.com.br/api/analytics/ai-agents?from=...&to=..." \
  -H "Authorization: Bearer $ZAPYFLOW_API_KEY"
Respostas
  • 200 — OK
  • 400 — Requisição malformada
  • 403 — Proibido, ou a chave não tem este escopo

GET/api/analytics/messages

Serie temporal de mensagens, em series mutuamente exclusivas

Escopo exigido: analytics.read

ParâmetroOndeObrigatório
fromquerysim
toquerysim
granularityquerynão
bash
curl "https://api.zapyflow.com.br/api/analytics/messages?from=...&to=..." \
  -H "Authorization: Bearer $ZAPYFLOW_API_KEY"
Respostas
  • 200 — OK
  • 400 — Requisição malformada

GET/api/analytics/overview

Resumo do periodo, com o periodo anterior medido

Escopo exigido: analytics.read

ParâmetroOndeObrigatório
fromquerysim
toquerysim
bash
curl "https://api.zapyflow.com.br/api/analytics/overview?from=...&to=..." \
  -H "Authorization: Bearer $ZAPYFLOW_API_KEY"
Respostas
  • 200 — OK
  • 400 — Requisição malformada

GET/api/analytics/response-time

Tempo de resposta por TURNO de conversa: media, mediana, p95 e maximo

Escopo exigido: analytics.read

ParâmetroOndeObrigatório
fromquerysim
toquerysim
bash
curl "https://api.zapyflow.com.br/api/analytics/response-time?from=...&to=..." \
  -H "Authorization: Bearer $ZAPYFLOW_API_KEY"
Respostas
  • 200 — OK
  • 400 — Requisição malformada
  • 403 — Proibido, ou a chave não tem este escopo