ZapyFlow/API documentationopenapi.json

Analytics

Metrics and reports

GET/api/analytics/ai-agents

Per-agent performance over the period

Required scope: analytics.read

ParameterInRequired
fromqueryyes
toqueryyes
bash
curl "https://api.zapyflow.com.br/api/analytics/ai-agents?from=...&to=..." \
  -H "Authorization: Bearer $ZAPYFLOW_API_KEY"
Responses
  • 200 — OK
  • 400 — Malformed request
  • 403 — Forbidden, or the key lacks this scope

GET/api/analytics/messages

Message time series, in mutually exclusive series

Required scope: analytics.read

ParameterInRequired
fromqueryyes
toqueryyes
granularityqueryno
bash
curl "https://api.zapyflow.com.br/api/analytics/messages?from=...&to=..." \
  -H "Authorization: Bearer $ZAPYFLOW_API_KEY"
Responses
  • 200 — OK
  • 400 — Malformed request

GET/api/analytics/overview

Summary of the period, with the previous period measured for comparison

Required scope: analytics.read

ParameterInRequired
fromqueryyes
toqueryyes
bash
curl "https://api.zapyflow.com.br/api/analytics/overview?from=...&to=..." \
  -H "Authorization: Bearer $ZAPYFLOW_API_KEY"
Responses
  • 200 — OK
  • 400 — Malformed request

GET/api/analytics/response-time

Response time per conversation TURN: mean, median, p95 and max

Required scope: analytics.read

ParameterInRequired
fromqueryyes
toqueryyes
bash
curl "https://api.zapyflow.com.br/api/analytics/response-time?from=...&to=..." \
  -H "Authorization: Bearer $ZAPYFLOW_API_KEY"
Responses
  • 200 — OK
  • 400 — Malformed request
  • 403 — Forbidden, or the key lacks this scope