Skip to content

Get the engagement report

API v2 is in public beta: endpoints and fields can change before general availability. See the changelog

GET/preorders/reports/engagement

Costs 1 rate-limit point · Rate limits

Preorder button engagement: impressions, add-to-carts, add-to-cart rate, orders and order rate, shop-wide and per variant: the merchant's Products > Engagement view.

Rates use unique shoppers; total_* fields count every event. order_rate can exceed 1.0: orders are placed preorder orders, a different denominator than unique add-to-carts. from/to default to the shop's lifetime. variants is paged and sorted by sort_by (default impressions); shopify_variant_ids narrows it. pixel_active is false until the STOQ web pixel is set up (POST /account/web_pixel/enable); 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).

Also searched aspreorder engagementpreorder funneladd to cart ratebutton engagementpreorder performance

Query parameters

  • fromstring

    First day of the window, as YYYY-MM-DD. Defaults to the day the shop installed STOQ.

  • tostring

    Last day of the window, as YYYY-MM-DD. Default today.

  • shopify_market_idstring

    Only engagement in this Shopify market, as a market gid (gid://shopify/Market/<id>) or numeric id.

  • shopify_variant_idsarray

    Only these variants in the per-variant rows, as Shopify variant gids or numeric ids (an array or one comma-separated string, up to 250).

  • sort_bystring

    Column to sort the variant rows by. Default impressions.

    One of impressionsadd_to_cartsadd_to_cart_ratetotal_impressionstotal_add_to_carts
    Default "impressions"
  • directionstring

    Sort order of the rows. Default desc.

    One of ascdesc
    Default "desc"
  • pageinteger

    Page of rows to return, starting at 1.

    Default 1
  • per_pageinteger

    Variant rows per page, 1 to 250. Default 50, or 250 when shopify_variant_ids is sent.

    Default 50

Returns

  • pixel_activeboolean
    Example: true
  • windowobject

    The date range the figures cover. Null when range is all_time.

    Show 2 child attributesHide child attributes
    • fromstring

      Start of the range, ISO 8601.

    • tostring

      End of the range, ISO 8601.

  • impressionsinteger
    Example: 1
  • total_impressionsinteger
    Example: 1
  • add_to_cartsinteger
    Example: 1
  • total_add_to_cartsinteger
    Example: 1
  • add_to_cart_rateinteger
    Example: 1
  • ordersinteger
    Example: 1
  • order_rateinteger
    Example: 1
  • sort_bystring
    Example: string
  • directionstring
    Example: string
  • variantsarray of objects
    Show 12 child attributesHide child attributes
    • shopify_variant_idstring
      Example: string
    • shopify_product_idstring
      Example: string
    • product_titlestring
      Example: string
    • variant_titlestring
      Example: string
    • image_urlstring
      Example: string
    • impressionsinteger
      Example: 1
    • total_impressionsinteger
      Example: 1
    • add_to_cartsinteger
      Example: 1
    • total_add_to_cartsinteger
      Example: 1
    • add_to_cart_ratenumber
      Example: 1.5
    • ordersinteger
      Example: 1
    • order_ratenumber
      Example: 1.5
  • metaobject

    Pagination for the list.

    Show 4 child attributesHide child attributes
    • total_countinteger

      Items matching the filters, across all pages.

    • pageinteger

      Page returned, starting at 1.

    • per_pageinteger

      Most items per page.

    • total_pagesinteger

      Pages available at this per_page; 0 when nothing matches.

Errors

422
validation_failed

The action refused the request for a reason that is not a single bad field.

Any request can also fail with auth_invalid (401) or rate_limited (429).

Every error has the same shape: see Errors and the list of error codes.

GET/preorders/reports/engagement
curl "https://app.stoqapp.com/api/v2/external/preorders/reports/engagement" \
  -H "X-Auth-Token: $STOQ_API_KEY"
Response
{
  "pixel_active": true,
  "window": {
    "from": "2026-01-15",
    "to": "2026-01-15"
  },
  "impressions": 1,
  "total_impressions": 1,
  "add_to_carts": 1,
  "total_add_to_carts": 1,
  "add_to_cart_rate": 1,
  "orders": 1,
  "order_rate": 1,
  "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,
      "add_to_carts": 1,
      "total_add_to_carts": 1,
      "add_to_cart_rate": 1.5,
      "orders": 1,
      "order_rate": 1.5
    }
  ],
  "meta": {
    "total_count": 1,
    "page": 1,
    "per_page": 1,
    "total_pages": 1
  }
}