ZapyFlow/Documentação da APIopenapi.json

Dashboard

Resumos da tela inicial

GET/api/dashboard/overview

Metricas do periodo selecionado (com sparkline) e KPIs para a home do dashboard

Escopo exigido: analytics.read

ParâmetroOndeObrigatório
periodquerynão
bash
curl "https://api.zapyflow.com.br/api/dashboard/overview" \
  -H "Authorization: Bearer $ZAPYFLOW_API_KEY"
Respostas
  • 200 — OK

GET/api/dashboard/recent

10 conversas recentes do time

Escopo exigido: analytics.read

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

GET/api/dashboard/reverse-trial-state

Estado do reverse trial (14d Starter) do team logado

Escopo exigido: workspace.read

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

GET/api/dashboard/stats

Estatisticas rapidas para os cards do dashboard

Escopo exigido: analytics.read

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