Referencia API

Métrica

Ejecute cualquier métrica del Panel mediante una definición JSON. Nunca SQL.

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

post/api/v1/query

Permiso clave: leitura

Cuerpo (JSON)

definition object

Ejemplo: {"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"}

Respuestas

200Resultado

Pedido

curl -X POST "https://www.cyzyra.com/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"}}'

Przykład ilustrujący.

AnteriorPagos PróximoPreguntas