PT EN

Definições de relatório

URL base: $BUSINESS_API

Listar definições de relatório

Registos

GET /definitions

Returns the report definitions the tenant can run, one cursor page at a time: its own definitions plus the platform-wide ones. The handler also accepts a category filter. Requires reports:read.

Parâmetros

limitinteger · consulta · opcional

Maximum resources to return (default 20, maximum 100).

afterstring · consulta · opcional

Opaque cursor returned by the previous page.

Devolve

200 Report definitions

Permissões reports:read · Funções: admin, analyst, finance, owner

curl -X GET "$BUSINESS_API/definitions" \
  -H "Authorization: Bearer sk_test_..."
Resposta 200

Report definitions

Criar uma definição de relatório

Registos

POST /definitions

Creates a report definition scoped to the authenticated tenant. key, name and dataset_key are required; description and category are optional. The key must be unique within the tenant, and a duplicate returns 409. Requires reports:write.

Devolve

201 Definition created

Permissões reports:write · Funções: admin, analyst, finance, owner

curl -X POST "$BUSINESS_API/definitions" \
  -H "Authorization: Bearer sk_test_..."
Resposta 201

Definition created

Obter uma definição de relatório

Registos

GET /definitions/{id}

Returns one report definition that the tenant can see, either its own or a platform-wide one. Requires reports:read; a definition belonging to another tenant, or an unknown ID, returns 404.

Parâmetros

idstring · caminho · obrigatório

Identifier of the report definition.

Devolve

200 Report definition

Erros 403 · 404

Permissões reports:read · Funções: admin, analyst, finance, owner

curl -X GET "$BUSINESS_API/definitions/{id}" \
  -H "Authorization: Bearer sk_test_..."
Resposta 200

Report definition