---
title: "Get the engagement report"
description: "Back-in-stock \"Notify me\" button engagement: impressions, clicks, click rate, signups and signup rate, shop-wide and per variant — the merchant's Products > Engagement view."
url: https://docs.stoqapp.com/v2-reference/back-in-stock-reports/get-the-engagement-report/
api: "API v2 reference"
method: GET
path: "/back_in_stock/reports/engagement"
---

# Get the engagement report

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

Back-in-stock &quot;Notify me&quot; button engagement: impressions, clicks, click rate, signups and signup rate, shop-wide and per variant: the merchant's Products &gt; Engagement view.

**Note:** Rates use unique shoppers; total_* fields count every event. from/to default to the shop's lifetime. variants is paged and sorted by sort_by (default impressions); shopify_variant_ids narrows it. This is button engagement, not conversion: orders from notified customers are in /back_in_stock/reports/summary. pixel_active is false until the STOQ web pixel is set up ([`POST /account/web_pixel/enable`](https://docs.stoqapp.com/v2-reference/account-web-pixel/enable-the-web-pixel/)); the dashboard shows a set-up prompt instead of these numbers then. Each variant row's image_url is the variant's stored image, else the product's (null if none is stored).

## Query parameters

- `from` (string): First day of the window. Default the day the shop installed the app.
- `to` (string): Last day of the window. Default today.
- `shopify_market_id` (string): Only engagement in this Shopify market, as a gid or a numeric id.
- `shopify_variant_ids` (array): Only these Shopify variants, as gids or numeric ids (a comma-separated string also works), up to 250.
- `sort_by` (string): Column to sort variants by. Default impressions. One of: `impressions`, `clicks`, `click_rate`, `signups`, `signup_rate`, `total_impressions`, `total_clicks`, `total_signups`.
- `direction` (string): Sort direction. Default desc. One of: `asc`, `desc`.
- `page` (integer): Page of results to return, starting at 1.
- `per_page` (integer): Variants per page, 1 to 250. Default 50, or 250 when shopify_variant_ids is given.

## Returns

- `pixel_active` (boolean): e.g. `true`
- `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.
- `impressions` (integer): e.g. `1`
- `total_impressions` (integer): e.g. `1`
- `clicks` (integer): e.g. `1`
- `total_clicks` (integer): e.g. `1`
- `click_rate` (number): e.g. `1.5`
- `signups` (integer): e.g. `1`
- `total_signups` (integer): e.g. `1`
- `signup_rate` (number): e.g. `1.5`
- `sort_by` (string): e.g. `string`
- `direction` (string): e.g. `string`
- `variants` (array of objects)
  - `shopify_variant_id` (string): e.g. `string`
  - `shopify_product_id` (string): e.g. `string`
  - `product_title` (string): e.g. `string`
  - `variant_title` (string): e.g. `string`
  - `image_url` (string): e.g. `string`
  - `impressions` (integer): e.g. `1`
  - `total_impressions` (integer): e.g. `1`
  - `clicks` (integer): e.g. `1`
  - `total_clicks` (integer): e.g. `1`
  - `click_rate` (number): e.g. `1.5`
  - `signups` (integer): e.g. `1`
  - `total_signups` (integer): e.g. `1`
  - `signup_rate` (number): e.g. `1.5`
- `meta` (object): Pagination for the list.
  - `total_count` (integer): Items matching the filters, across all pages.
  - `page` (integer): Page returned, starting at 1.
  - `per_page` (integer): Most items per page.
  - `total_pages` (integer): Pages available at this per_page; 0 when nothing matches.

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

## Examples

### Get the engagement report

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

### Get the engagement report filtered by shopify_market_id, shopify_variant_ids and sort_by

```sh
curl "https://app.stoqapp.com/api/v2/external/back_in_stock/reports/engagement?shopify_market_id=gid%3A%2F%2Fshopify%2FMarket%2F12345&shopify_variant_ids=45000000001&sort_by=impressions" \
  -H "X-Auth-Token: $STOQ_API_KEY"
```

## 200

Success: the requested resource.

```json
{
  "pixel_active": true,
  "window": {
    "from": "2026-01-15",
    "to": "2026-01-15"
  },
  "impressions": 1,
  "total_impressions": 1,
  "clicks": 1,
  "total_clicks": 1,
  "click_rate": 1.5,
  "signups": 1,
  "total_signups": 1,
  "signup_rate": 1.5,
  "sort_by": "string",
  "direction": "string",
  "variants": [
    {
      "shopify_variant_id": "string",
      "shopify_product_id": "string",
      "product_title": "string",
      "variant_title": "string",
      "image_url": "string",
      "impressions": 1,
      "total_impressions": 1,
      "clicks": 1,
      "total_clicks": 1,
      "click_rate": 1.5,
      "signups": 1,
      "total_signups": 1,
      "signup_rate": 1.5
    }
  ],
  "meta": {
    "total_count": 1,
    "page": 1,
    "per_page": 1,
    "total_pages": 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
    }
  ]
}
```

