Preview a report definition

Runs a definition without saving it, so a caller can see the result before creating the report.

POST/api/v1/reports/preview

Authorization

AuthorizationOAuth2 access token · headerrequired

Authorization-code grant with PKCE. Clients are public and hold no secret. Discovery is published at /.well-known/oauth-authorization-server/api/auth.

Scopes:api.access

Request body

requiredapplication/json

filtersobject[]

max items 10 · default: []

Show properties

Array of object

fieldstringrequired

matches ^[a-z][a-z0-9_]{0,62}$

valuestring | booleanrequired

groupBystring

matches ^[a-z][a-z0-9_]{0,62}$

limitinteger

min 1 · max 100 · default: 50

measureobjectrequired

Show properties

One of:

object

operationstringrequired

object

fieldstringrequired

matches ^[a-z][a-z0-9_]{0,62}$

operationstringrequired

Allowed:sumaverageminmax

objectIdstringrequired

min length 1 · max length 255

Responses

200

The rows the definition produces

Array of ReportResultRow

labelstring | nullrequired

valuestring | nullrequired

400

The request body, query or parameters were refused

codestringrequired

Allowed:invalid_inputnot_foundconflictforbidden

detailany

errorstringrequired

reasonstring

401

The access token is missing, invalid or revoked

errorstringrequired

403

The tenant's module is off, or the token's scope or the member's role does not permit the action

codestringrequired

Allowed:invalid_inputnot_foundconflictforbidden

detailany

errorstringrequired

reasonstring

404

No such record, or none the caller may read

codestringrequired

Allowed:invalid_inputnot_foundconflictforbidden

detailany

errorstringrequired

reasonstring

413

The request exceeds the route's body limit

errorstringrequired

500

An unexpected failure

errorstringrequired

Request

curl -X POST '/api/v1/api/v1/reports/preview' \
  -H 'Authorization: Bearer YOUR_ACCESS_TOKEN' \
  -H 'Accept: application/json' \
  -H 'Content-Type: application/json' \
  -d '{
  "filters": [],
  "groupBy": "string",
  "limit": 50,
  "measure": {
    "operation": "count"
  },
  "objectId": "string"
}'

const response = await fetch("/api/v1/api/v1/reports/preview", {
  method: "POST",
  headers: {
    "Authorization": "Bearer YOUR_ACCESS_TOKEN",
    "Accept": "application/json",
    "Content-Type": "application/json"
  },
  body: "{\n  \"filters\": [],\n  \"groupBy\": \"string\",\n  \"limit\": 50,\n  \"measure\": {\n    \"operation\": \"count\"\n  },\n  \"objectId\": \"string\"\n}"
});

import requests

response = requests.post(
    "/api/v1/api/v1/reports/preview",
    headers={
        "Authorization": "Bearer YOUR_ACCESS_TOKEN",
        "Accept": "application/json",
        "Content-Type": "application/json"
    },
    data="{\n  \"filters\": [],\n  \"groupBy\": \"string\",\n  \"limit\": 50,\n  \"measure\": {\n    \"operation\": \"count\"\n  },\n  \"objectId\": \"string\"\n}",
)

Response

[
  {
    "label": "string",
    "value": "string"
  }
]

{
  "code": "invalid_input",
  "detail": null,
  "error": "string",
  "reason": "string"
}

{
  "error": "string"
}

{
  "code": "invalid_input",
  "detail": null,
  "error": "string",
  "reason": "string"
}

{
  "code": "invalid_input",
  "detail": null,
  "error": "string",
  "reason": "string"
}

{
  "error": "string"
}

{
  "error": "string"
}