Reports

Queue an export of the top offerings report

Queues a CSV export of the top offerings report to be generated asynchronously.

get/shop/reports/top-offerings/queue

Query parameters

site_idstring uuid

Restrict to items at the given site.

revenue_date_fromstring date

Example:2026-01-01

Restrict to items belonging to baskets with a revenue date on or after this date.

revenue_date_tostring date

Example:2026-12-31

Restrict to items belonging to baskets with a revenue date on or before this date.

item_date_fromstring date

Restrict to items dated on or after this date.

item_date_tostring date

Restrict to items dated on or before this date.

offering_typestring

Filter to items of a particular offering type.

offering_idsstring[]

A comma-separated list of offering IDs to filter on.

emailboolean

If true, email the completed CSV to the authenticated user when the background job finishes. Defaults to false, in which case the queued job's output URL must be polled via the queued-jobs endpoint.

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.