Drill Down Into Aggregated Row

POST 
/api/v2/report-builder/drill-down

Execute a drill-down query for a row in an aggregated report. Pass the same definition used to produce the parent row along with a drill_values map of {dimension_alias: value} pairs to isolate the underlying detail records.

Required scope: reports:write

Grant this scope to your token under Settings → Developer → Personal Access Tokens.

Returns rows from the base entity that match all supplied drill values, respecting the definition's filters and tenant isolation. Use for powering drill-down drawers in the UI.

Request

Responses

200

Successful response

401

Unauthenticated — the bearer token is missing, revoked, expired, or malformed. Never retry automatically; fix the credential. See the Errors guide.

403

Forbidden — the token lacks a required scope, the endpoint is not available to API tokens, or the user behind the token lacks the permission. A human must adjust the token scopes or user permissions; do not retry.

422

Validation failed — the body is a field → messages map (Laravel shape) or the platform envelope with a stable machine-readable code. Fix the payload and resubmit.

429

Rate limited — platform limit is 1,000 requests/min; individual tokens may carry lower limits. Honor the Retry-After header before retrying. See the Rate Limits guide.