---
title: "Get the report summary"
description: "The Preorders Overview tiles over a date window: orders, units sold, revenue (total sales), preorder line item revenue, average order value, unpaid orders and the balance they owe, unfulfilled orders and unique customers"
url: https://docs.stoqapp.com/v2-reference/preorders-reports/get-the-report-summary/
api: "API v2 reference"
method: GET
path: "/preorders/reports/summary"
---

# Get the report summary

`GET https://app.stoqapp.com/api/v2/external/preorders/reports/summary`

The Preorders Overview tiles over a date window: orders, units sold, revenue (total sales), preorder line item revenue, average order value, unpaid orders and the balance they owe, unfulfilled orders and unique customers.

**Note:** The same numbers as the dashboard tiles and the Home analytics card, summed from the shop's daily totals. Every total leaves cancelled orders out, units_sold and line_item_revenue included. range=all_time reads orders and revenue from the shop's lifetime totals, as Home's All time does. unpaid_orders and unpaid_balance are read live from the orders placed in the window (every order for all_time): the orders that still owe a balance now and the sum still to collect. Cancelled, refunded and voided orders are left out; a partially refunded order that still owes counts. unfulfilled_orders and unique_customers are read live from the same orders: unfulfilled_orders is how many still have preorder items to ship (on hold, scheduled or ready to ship), and unique_customers is how many different customers placed them.

## Query parameters

- `range` (string): Send all_time for the shop's whole history instead of a from/to window; from and to are then ignored. One of: `all_time`, `null`.
- `from` (string): Start of the window, as an ISO 8601 date or time. A bare date starts at midnight in the shop's time zone. Default 30 days ago.
- `to` (string): End of the window, as an ISO 8601 date or time. A bare date runs to the end of that day in the shop's time zone. Default today.

## Returns

- `window` (object, nullable): The date range the figures cover. Null when range is all_time.
  - `from` (string): Start of the range, ISO 8601.
  - `to` (string): End of the range, ISO 8601.
- `currency` (null): ISO 4217 code of the currency the money amounts in this response are in: the order's for an order, else the shop's. Null when it is not known.
- `totals` (object)
  - `orders` (integer): e.g. `1`
  - `units_sold` (integer): e.g. `1`
  - `revenue` (string): e.g. `string`
  - `line_item_revenue` (string): e.g. `string`
  - `average_order_value` (string): e.g. `string`
  - `unpaid_orders` (integer): e.g. `1`
  - `unpaid_balance` (string): e.g. `string`
  - `unfulfilled_orders` (integer): e.g. `1`
  - `unique_customers` (integer): e.g. `1`

Rate limit: this call costs 1 point ([rate limits](https://docs.stoqapp.com/docs/rate-limits/)).

## Examples

### Get the report summary

```sh
curl "https://app.stoqapp.com/api/v2/external/preorders/reports/summary" \
  -H "X-Auth-Token: $STOQ_API_KEY"
```

### Get the report summary filtered by range

```sh
curl "https://app.stoqapp.com/api/v2/external/preorders/reports/summary?range=all_time" \
  -H "X-Auth-Token: $STOQ_API_KEY"
```

## 200

Success: the requested resource.

```json
{
  "window": {
    "from": "2026-01-15T09:30:00Z",
    "to": "2026-01-15T09:30:00Z"
  },
  "currency": null,
  "totals": {
    "orders": 1,
    "units_sold": 1,
    "revenue": "string",
    "line_item_revenue": "string",
    "average_order_value": "string",
    "unpaid_orders": 1,
    "unpaid_balance": "string",
    "unfulfilled_orders": 1,
    "unique_customers": 1
  }
}
```

## 401

Missing or invalid `X-Auth-Token`.

```json
{
  "errors": [
    "Invalid API key"
  ],
  "code": "auth_invalid",
  "details": [
    {
      "code": "auth_invalid",
      "message": "Invalid API key",
      "path": null,
      "value": null,
      "expected": null
    }
  ]
}
```

## 422

The request failed validation.

```json
{
  "errors": [
    "name is required"
  ],
  "code": "validation_failed",
  "details": [
    {
      "code": "validation_failed",
      "message": "name is required",
      "path": null,
      "value": null,
      "expected": null
    }
  ]
}
```

## 429

Rate limited: cost-weighted per token (read 1, write 2; 360 points / 60s). Check `Retry-After`.

```json
{
  "errors": [
    "Rate limit exceeded"
  ],
  "code": "rate_limited",
  "details": [
    {
      "code": "rate_limited",
      "message": "Rate limit exceeded",
      "path": null,
      "value": null,
      "expected": null
    }
  ]
}
```

