Referência da API

Métricas

Rode qualquer métrica dos Painéis por uma definição em JSON. Nunca SQL.

Rodar uma métrica (definição JSON dos Painéis, nunca SQL)

post/api/v1/query

Permissão da chave: leitura

Corpo (JSON)

definition object

Exemplo: {"type":"simple","entity":"payments","agg":"sum","field":"amount","filters":[{"field":"status","op":"in","value":["paid","settled","available"]}],"dateField":"paid_at","period":"month","groupBy":"lead_state"}

Respostas

200Resultado

Requisição

curl -X POST "https://cyzyra.vercel.app/api/v1/query" \
  -H "Authorization: Bearer $CYZYRA_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{"definition":{"type":"simple","entity":"payments","agg":"sum","field":"amount","filters":[{"field":"status","op":"in","value":["paid","settled","available"]}],"dateField":"paid_at","period":"month"}}'

Exemplo ilustrativo.

AnteriorPagamentos PróximoPerguntas