Aggregate records with a chart spec

Run a chart and return its aggregated data as columns plus rows: pass record_chart_id for a saved chart or an inline spec to try one out. The database groups and aggregates; rows never contain single records.

Authorization

bearerApiKey

AuthorizationBearer <token>

Create a scoped API key in the Adlass settings.

In: header

Header Parameters

X-Request-Id?string

Optional correlation identifier.

Lengthlength <= 128

Request Body

application/json

TypeScript Definitions

Use the request body type in TypeScript.

record_chart_id?string

Formatuuid

spec?

Declarative chart: source (record_type_id, optional view key, filter tree, date_field, last_days), x and series dimensions ({field, bucket, top}; field may be relation_key or relation_key.field_key), 1-4 measures ({op, field, label}) and chart {type, stacked, horizontal}. Read the records_charts guide.

time_zone?string

IANA zone for date buckets, default UTC.

Lengthlength <= 64

days?integer

Overrides source.last_days.

Range1 <= value <= 3650

limit?integer

Range1 <= value <= 2000

Response Body

`application/json`

`application/problem+json`

curl -X POST "https://example.com/records/charts/data" \  -H "Content-Type: application/json" \  -d '{}'

{}

Aggregate records with a chart spec

Authorization

Header Parameters

Request Body

Response Body

200application/json

400application/problem+json

401application/problem+json

402application/problem+json

403application/problem+json

404application/problem+json

405application/problem+json

409application/problem+json

410application/problem+json

413application/problem+json

415application/problem+json

422application/problem+json

429application/problem+json

500application/problem+json

502application/problem+json

503application/problem+json

504application/problem+json

`application/json`

`application/problem+json`

`application/problem+json`

`application/problem+json`

`application/problem+json`

`application/problem+json`

`application/problem+json`

`application/problem+json`

`application/problem+json`

`application/problem+json`

`application/problem+json`

`application/problem+json`

`application/problem+json`

`application/problem+json`

`application/problem+json`

`application/problem+json`

`application/problem+json`