Get revenue statistics

Request

Retrieve revenue statistics for a configurable date range. Returns revenue, order counts, average order amount, and other useful statistics.

Security

ApiKey or OAuth2(Required scopes: revenue:read)

Query

startDatestring, (date-time)

Start date for the revenue calculation period (ISO 8601 datetime format). Defaults to 30 days ago if not provided.

Example:startDate=2026-01-01T00:00:00Z

endDatestring, (date-time)

End date for the revenue calculation period (ISO 8601 datetime format). Defaults to current time if not provided.

Example:endDate=2026-01-31T23:59:59Z

curl -i -X GET \
  'https://cafe.redocly.com/_mock/openapi/cafe/revenue?startDate=2026-01-01T00%3A00%3A00Z&endDate=2026-01-31T23%3A59%3A59Z' \
  -H 'X-API-Key: YOUR_API_KEY_HERE'

Responses

Revenue statistics retrieved successfully.

Bodyapplication/json

revenuenumber, (float), >= 0required

Total revenue in cents from completed orders.

averageOrderAmountnumber, (float), >= 0required

Average order amount in cents (calculated from completed orders only).

totalOrdersinteger, >= 0required

Total number of orders (all statuses) in the date range.

placedOrdersinteger, >= 0required

Number of placed orders.

preparingOrdersinteger, >= 0required

Number of preparing orders.

completedOrdersinteger, >= 0required

Number of completed orders.

canceledOrdersinteger, >= 0required

Number of canceled orders.

startDatestring, (date-time)required

Start date of the revenue calculation period.

endDatestring, (date-time)required

End date of the revenue calculation period.

Response

{
  "revenue": 0.1,
  "averageOrderAmount": 0.1,
  "totalOrders": 0,
  "placedOrders": 0,
  "preparingOrders": 0,
  "completedOrders": 0,
  "canceledOrders": 0,
  "startDate": "2019-08-24T14:15:22Z",
  "endDate": "2019-08-24T14:15:22Z"
}