Get engagement

GET

/preorders/reports/engagement

curl --request GET \
  --url 'https://app.stoqapp.com/api/v2/external/preorders/reports/engagement?from=string&to=string&market_id=gid%3A%2F%2Fshopify%2FMarket%2F12345&variant_ids=45000000001' \
  --header 'X-Auth-Token: <X-Auth-Token>'

• Production

Preorder button engagement/funnel analytics: impressions, add-to-carts, add-to-cart rate, orders, and order rate — the same numbers on the merchant’s preorder Engagement dashboard. Rates use unique shoppers. order_rate can exceed 1.0 because orders come from placed preorder orders, a different denominator than unique add-to-carts.

Authorizations

• ApiKeyAuth

Parameters

Query Parameters

from

Example

string

to

Example

string

market_id

Example

gid://shopify/Market/12345

variant_ids

Example

[
  "45000000001"
]

Responses

200

Success — the requested resource.

Media typeapplication/json

object

Example ^generated

{}

401

Missing or invalid X-Auth-Token.

Media typeapplication/json

Error envelope returned by every failed request.

object

errors

required

Array<string>

Example

{
  "errors": [
    "Unauthorized"
  ]
}

422

The request failed validation.

Media typeapplication/json

Error envelope returned by every failed request.

object

errors

required

Array<string>

Example

{
  "errors": [
    "name is required"
  ]
}

429

Rate limited — cost-weighted per token (read 1, write 2; 360 points / 60s). Check Retry-After.

Media typeapplication/json

Error envelope returned by every failed request.

object

errors

required

Array<string>

Example

{
  "errors": [
    "Rate limit exceeded"
  ]
}