Sign in
Reports

Queue an export of the revenue projection report

Queues a CSV export of the revenue projection report, generated asynchronously on a background worker. The same 31-day maximum range applies as for the synchronous endpoint.

get/shop/reports/revenue-projection/queue

Query parameters

site_idstring uuid

Restrict the projection to baskets at the given site.

revenue_date_fromstring date
Example:2026-06-01

Restrict to baskets with a revenue date on or after this date. Either this and revenue_date_to must be provided, or item_date_from and item_date_to. The total range cannot exceed 31 days.

revenue_date_tostring date
Example:2026-06-30

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

item_date_fromstring date

Restrict to baskets containing items dated on or after this date.

item_date_tostring date

Restrict to baskets containing items dated on or before this date.

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.