Sign in
OrganisationReports

Queue an export of the organisation top offerings report.

This endpoint queues an export of the organisation top offerings report.

get/shop/reports/organisation/top-offerings/queue

Query parameters

revenue_date_fromstring date
Example:2024-03-01

Include revenues on or after this date.

revenue_date_tostring date
Example:2024-03-31

Include revenues on or before this date.

date_fromstring date

Restrict results to those on or after this date, ISO-8601 YYYY-MM-DD.

date_tostring date

Restrict results to those on or before this date, ISO-8601 YYYY-MM-DD.

offering_typestring[]

Include items of this type.

[
  "appointment"
]

Response

The job was successfully queued

Example response

{
  "data": {
    "created_at": "2023-11-07T00:00:00+00:00",
    "updated_at": "2023-11-07T01:00:00+00:00"
  }
}

Changes

No recorded changes to this endpoint across all 1 revision of this API.