ZapyFlow/Documentación de la APIopenapi.json

Analytics

Métricas e informes

GET/api/analytics/ai-agents

Rendimiento por agente de IA en el periodo

Ámbito requerido: analytics.read

ParámetroDóndeObligatorio
fromquerysí
toquerysí
bash
curl "https://api.zapyflow.com.br/api/analytics/ai-agents?from=...&to=..." \
  -H "Authorization: Bearer $ZAPYFLOW_API_KEY"
Respuestas
  • 200 — OK
  • 400 — Petición malformada
  • 403 — Prohibido, o la clave no tiene este ámbito

GET/api/analytics/messages

Serie temporal de mensajes, en series mutuamente excluyentes

Ámbito requerido: analytics.read

ParámetroDóndeObligatorio
fromquerysí
toquerysí
granularityqueryno
bash
curl "https://api.zapyflow.com.br/api/analytics/messages?from=...&to=..." \
  -H "Authorization: Bearer $ZAPYFLOW_API_KEY"
Respuestas
  • 200 — OK
  • 400 — Petición malformada

GET/api/analytics/overview

Resumen del periodo, con el periodo anterior medido para comparar

Ámbito requerido: analytics.read

ParámetroDóndeObligatorio
fromquerysí
toquerysí
bash
curl "https://api.zapyflow.com.br/api/analytics/overview?from=...&to=..." \
  -H "Authorization: Bearer $ZAPYFLOW_API_KEY"
Respuestas
  • 200 — OK
  • 400 — Petición malformada

GET/api/analytics/response-time

Tiempo de respuesta por TURNO de conversación: media, mediana, p95 y máximo

Ámbito requerido: analytics.read

ParámetroDóndeObligatorio
fromquerysí
toquerysí
bash
curl "https://api.zapyflow.com.br/api/analytics/response-time?from=...&to=..." \
  -H "Authorization: Bearer $ZAPYFLOW_API_KEY"
Respuestas
  • 200 — OK
  • 400 — Petición malformada
  • 403 — Prohibido, o la clave no tiene este ámbito