ZapyFlow/API documentationopenapi.json

Dashboard

Home screen summaries

GET/api/dashboard/overview

Metrics for the selected period (with sparkline) and KPIs for the dashboard home

Required scope: analytics.read

ParameterInRequired
periodqueryno
bash
curl "https://api.zapyflow.com.br/api/dashboard/overview" \
  -H "Authorization: Bearer $ZAPYFLOW_API_KEY"
Responses
  • 200 — OK

GET/api/dashboard/recent

The team's 10 most recent conversations

Required scope: analytics.read

bash
curl "https://api.zapyflow.com.br/api/dashboard/recent" \
  -H "Authorization: Bearer $ZAPYFLOW_API_KEY"
Responses
  • 200 — OK

GET/api/dashboard/reverse-trial-state

State of the reverse trial (14-day Starter) for the current team

Required scope: workspace.read

bash
curl "https://api.zapyflow.com.br/api/dashboard/reverse-trial-state" \
  -H "Authorization: Bearer $ZAPYFLOW_API_KEY"
Responses
  • 200 — OK

GET/api/dashboard/stats

Quick stats for the dashboard cards

Required scope: analytics.read

bash
curl "https://api.zapyflow.com.br/api/dashboard/stats" \
  -H "Authorization: Bearer $ZAPYFLOW_API_KEY"
Responses
  • 200 — OK