Skip to main content
GET
Run a custom report

Authorizations

Authorization
string
header
required

Supabase JWT — Authorization: Bearer <token>.

Query Parameters

merchant_id
string<uuid>

Optional merchant to scope to. Admins and sub-merchant operators only; other callers always use their token's merchant.

Example:

"28106cba-1c27-4e53-b149-32113e5e8e31"

id
string<uuid>
required

Report id (from list_reports).

filters
string

Optional JSON ReportFilters to apply on top, e.g. {"period":{"preset":"last_month"}}.

block_id
string

Run only this block.

draft
enum<string>
default:false

Run the unpublished draft instead (only if you can edit the report).

Available options:
true,
false
Example:

"false"

Response

Block results.

filters
object
required

The filters the blocks ran with (report defaults, then your saved filters, then the ones you passed).

blocks
object[]
required
report_id
string<uuid>
title
string
version
integer
{key}
unknown