---
title: "Get the conversions report"
description: "The Back in stock Overview orders chart: orders attributed to back-in-stock alerts and their revenue per day, week or month."
url: https://docs.stoqapp.com/v2-reference/back-in-stock-reports/get-the-conversions-report/
api: "API v2 reference"
method: GET
path: "/back_in_stock/reports/conversions"
---

# Get the conversions report

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

The Back in stock Overview orders chart: orders attributed to back-in-stock alerts and their revenue per day, week or month.

**Note:** The same points as the dashboard chart, counted live: orders attributed at medium or high confidence. interval is daily up to 60 days, weekly up to 180, then monthly, and buckets are UTC days as on the chart. range=all_time is the dashboard's All time.

## 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.
- `interval` (string): e.g. `string`
- `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.
- `series` (array of objects)
  - `date` (string): e.g. `2026-01-15`
  - `orders` (integer): e.g. `1`
  - `revenue` (string): e.g. `string`

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

## Examples

### Get the conversions report

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

### Get the conversions report filtered by range

```sh
curl "https://app.stoqapp.com/api/v2/external/back_in_stock/reports/conversions?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"
  },
  "interval": "string",
  "currency": null,
  "series": [
    {
      "date": "2026-01-15",
      "orders": 1,
      "revenue": "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
    }
  ]
}
```

