Ejecuta un reporte de la reporteria

Sincrono hasta 5000 filas. Con async=true responde 202 con meta.jobId; consulte GET /reportes/jobs/{jobId}.

Scope requerido: reportes:read

Puede responder 202 con meta.jobId; consulte GET /reportes/jobs/{jobId}.

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…

Sincrono hasta 5000 filas. Con async=true responde 202 con meta.jobId; consulte GET /reportes/jobs/{jobId}.

Scope requeridoreportes:read
MétodoPOST /ext/v3/reportes/ejecutar
Asíncronopuede responder 202 con meta.jobId

Body

ParámetroTipoRequeridoDescripción
configobjectsíConfig de reporteria (campos y metricas de GET /reportes/catalogo)
asyncbooleannoEjecutar como trabajo asincrono Default false.

Ejemplo

curl -X POST 'https://api3.clau.io/ext/v3/reportes/ejecutar' \
  -H 'apikey: ck_1_...' \
  -H 'Content-Type: application/json' \
  -d '{"config":{"type":"lealtad","fields":["customer.email","customer.full_name","loyalty.points_value","loyalty.points_date"],"filters":[{"field":"loyalty.points_date","operator":"between","value":["2026-08-01","2026-08-31"]}],"sort":[{"field":"loyalty.points_date","direction":"desc"}],"limit":500}}'

Respuesta 200

{
  "codigoRespuesta": 0,
  "msj": "Exito",
  "data": "…",
  "meta": {
    "requestId": "5f1c…",
    "appId": 1,
    "scope": "reportes:read"
  }
}

Errores: 401 key inválida (9501), 403 sin scope (9503, meta.requiredScope), 400 parámetros (details), 409 idempotencia, 422 regla de negocio (meta.legacy), 429 límite de tasa. Agregue ?help=true para la ayuda en texto plano.

Query Params
boolean

Con true devuelve la ayuda del endpoint en texto plano.

Body Params
config
object
required

Config de reporteria (campos y metricas de GET /reportes/catalogo)

boolean
Defaults to false

Ejecutar como trabajo asincrono

Responses

Language
Credentials
URL
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json