---
title: "Retrieve product revenue"
description: "Revenue, units and orders from back-in-stock alerts per variant (or product), as the dashboard's revenue table."
url: https://docs.stoqapp.com/v2-reference/back-in-stock-reports/retrieve-product-revenue/
api: "API v2 reference"
method: GET
path: "/back_in_stock/reports/product_revenue"
---

# Retrieve product revenue

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

Revenue, units and orders from back-in-stock alerts per variant (or product), as the dashboard's revenue table.

**Note:** revenue is the line revenue of the alerted items only (not whole orders), so rows add up to the total without overlap. units_sold is item quantity; orders is distinct orders containing the item. image_url is the variant's stored image, else the product's (null if none is stored).

## Query parameters

- `group_by` (string) One of: `variant`, `product`.
- `from` (string)
- `to` (string)
- `range` (string)
- `sort_by` (string)
- `direction` (string)
- `page` (string)
- `per_page` (string)

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

## Examples

### Retrieve product revenue

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

### Retrieve product revenue filtered by group_by

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

## 200

Success: the requested resource.

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