Skip to main content
POST
Queue a report run

Authorizations

Authorization
string
header
required

Passport bearer token authentication for legacy admin sessions.

Path Parameters

id
integer
required

Record ID within the organization and any parent resource in this route.

Body

application/json

Request fields accepted by this operation. Omitted optional properties retain the behavior described above.

filterGroups
object[] | null

Field/operator/value filters validated against the chosen module, context and operator capabilities. filterGroups takes precedence over fields.

query
object
format
enum<string> | null

Validation: nullable|string|in:CSV,csv.

Available options:
CSV,
csv,
null
Example:

"CSV"

columns
string[] | null

Permitted runtime column keys or definitions.

export_locale
enum<string> | null
Available options:
en,
es,
fr,
de,
nl,
ar,
zhCn,
null
Example:

"en"

Response

Queue a report run response.

message
string
data
object
export
object