---
title: "Get the wait time report"
description: "How long back-in-stock shoppers have been waiting: median wait days, the longest wait, and a binned wait-time histogram (paid plans only)."
url: https://docs.stoqapp.com/v2-reference/back-in-stock-reports/get-the-wait-time-report/
api: "API v2 reference"
method: GET
path: "/back_in_stock/reports/wait_duration"
---

# Get the wait time report

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

How long back-in-stock shoppers have been waiting: median wait days, the longest wait, and a binned wait-time histogram (paid plans only).

**Note:** shopify_market_ids is a comma-separated list, as the waitlist page's Markets filter.

## Query parameters

- `shopify_variant_id` (string): Only this Shopify variant, as a gid or a numeric id.
- `shopify_product_id` (string): Only this Shopify product, as a gid or a numeric id.
- `shopify_market_ids` (string): Comma-separated Shopify market gids or numeric ids to keep.
- `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): 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.
- `median_wait_days` (number): e.g. `1.5`
- `max_wait_days` (integer): e.g. `1`
- `interval` (string): e.g. `string`
- `distribution` (array of objects)
  - `days` (integer): e.g. `1`
  - `count` (integer): e.g. `1`
- `distribution_included_in_plan` (boolean): e.g. `true`
- `shopify_market_ids` (array of strings)

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

## Examples

### Get the wait time report

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

### Get the wait time report filtered by shopify_variant_id, shopify_product_id and shopify_market_ids

```sh
curl "https://app.stoqapp.com/api/v2/external/back_in_stock/reports/wait_duration?shopify_variant_id=45000000001&shopify_product_id=78000000001&shopify_market_ids=gid%3A%2F%2Fshopify%2FMarket%2F12345" \
  -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"
  },
  "median_wait_days": 1.5,
  "max_wait_days": 1,
  "interval": "string",
  "distribution": [
    {
      "days": 1,
      "count": 1
    }
  ],
  "distribution_included_in_plan": true,
  "shopify_market_ids": [
    "string"
  ]
}
```

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

