Run Report

POST 
/report/:entityId/custom/:reportType

Runs a custom filtered report against the organization identified by entityId for the given reportType, returning matching detail rows, aggregated totals, or both.

Two companion endpoints supply the values you need: List Organization Members returns the entityId values you are allowed to query, and List Report Columns returns the valid reportType values and the exact column names for each. The request body is a CustomFilterRequest, whose fields are grouped into named filter buckets — combine as many as you need in a single request.

Key options and gotchas:

• include selects the shape of the response — data for detail rows, totals for aggregates, or data,totals for both.
• exportAs selects the output format, such as STREAM_JSONL or STREAM_CSV.
• confirmed is an event status, not a booking status — use eventStatuses for it and bookingStatuses for pipeline statuses such as Offer or Terms.
• Column names differ by reportType (for example Booking reports use Artists while Event and Settlement reports use Artist), so always confirm them with List Report Columns. Include Currency whenever you request financial columns.
• Filter enum values such as deal types must match the schema exactly and are typically uppercase, for example FLAT_GUARANTEE.

Request

Responses

200

Response shape depends on exportAs (STREAM_CSV_JSON envelope, STREAM_CSV raw, STREAM_JSONL NDJSON). Schema TBD.