---
title: "Get the report summary"
description: "The Back in stock Overview tiles over a date window: attributed orders and their revenue, average order value, distinct buyers, signups, and notifications sent by email and SMS."
url: https://docs.stoqapp.com/v2-reference/back-in-stock-reports/get-the-report-summary/
api: "API v2 reference"
method: GET
path: "/back_in_stock/reports/summary"
---

# Get the report summary

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

The Back in stock Overview tiles over a date window: attributed orders and their revenue, average order value, distinct buyers, signups, and notifications sent by email and SMS.

**Note:** The same numbers as the dashboard tiles and the Home analytics card, summed from the shop's daily totals. range=all_time reads revenue, orders, signups and notifications sent from the shop's lifetime totals, as Home's All time does. emails_sent and sms_sent count back-in-stock alerts only. sms_sent counts SMS sent: a failed send is left out (all_time still counts every SMS row). unique_customers is read live from the orders: how many different customers placed a confident back-in-stock order in the window (all of them for all_time). Shop-wide only. For people still waiting use products_in_demand or wait_duration.

## Query parameters

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

## 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. `38`
  - `revenue` (string): e.g. `4826.50`
  - `average_order_value` (string): e.g. `127.01`
  - `unique_customers` (integer): e.g. `35`
  - `signups` (integer): e.g. `412`
  - `notifications_sent` (integer): e.g. `296`
  - `emails_sent` (integer): e.g. `241`
  - `sms_sent` (integer): e.g. `55`

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/back_in_stock/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/back_in_stock/reports/summary?range=all_time" \
  -H "X-Auth-Token: $STOQ_API_KEY"
```

## 200

Success: example response shown.

```json
{
  "window": {
    "from": "2026-06-01T00:00:00-04:00",
    "to": "2026-06-30T23:59:59-04:00"
  },
  "currency": "USD",
  "totals": {
    "orders": 38,
    "revenue": "4826.50",
    "average_order_value": "127.01",
    "unique_customers": 35,
    "signups": 412,
    "notifications_sent": 296,
    "emails_sent": 241,
    "sms_sent": 55
  }
}
```

## 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
    }
  ]
}
```

