Drill Down Into Aggregated Row
POST/api/v2/report-builder/drill-down
Return the detail records behind one row of an aggregated report.
reports:writeGrant this scope to your token under Settings → Developer → Personal Access Tokens.
Body:
definition(object, required): the same builder definition that produced the aggregated row (same rules as Run Ad-Hoc Report)dimension_values(object, optional): the row's dimension values keyed by alias (entity__field, e.g.sales_orders__order_status). For a date dimension with agranularity, pass the bucketed value as it appears in the report (e.g.2026-09). Anullvalue matches records where the field is empty.limit(integer, optional, default 100, max 1000)
Response: columns (every dimension of the base entity: key, label, type), rows (keyed by dimension key, newest first) and row_count. Returns 422 for an unknown base entity.
Authentication: Bearer token (Personal Access Token). Personal access tokens need the reports:write scope.
Request
Responses
- 200
- 401
- 403
- 422
- 429
OK
Response Headers
Unauthenticated — the bearer token is missing, revoked, expired, or malformed. Never retry automatically; fix the credential. See the Errors guide.
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.
Unprocessable Entity
Response Headers
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.