Skip to content

Get the report summary

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

GET/back_in_stock/reports/summary

Costs 1 rate-limit point · Rate limits

The Back in stock Overview tiles over a date window: attributed orders and their revenue, average order value, distinct buyers, signups, and notifications sent by email and SMS.

The same numbers as the dashboard tiles and the Home analytics card, summed from the shop's daily totals. range=all_time reads revenue, orders, signups and notifications sent from the shop's lifetime totals, as Home's All time does. emails_sent and sms_sent count back-in-stock alerts only. sms_sent counts SMS sent: a failed send is left out (all_time still counts every SMS row). unique_customers is read live from the orders: how many different customers placed a confident back-in-stock order in the window (all of them for all_time). Shop-wide only. For people still waiting use products_in_demand or wait_duration.

Also searched assummaryoverviewhow is back in stock doingdashboard statsrecovered revenuenotifications sent

Query parameters

  • fromstring

    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.

  • tostring

    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.

  • rangestring

    Set to all_time for the shop's whole history instead of from/to.

    One of all_time

Returns

  • windowobject, nullable

    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.

  • currencynull

    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.

  • totalsobject
    Show 8 child attributesHide child attributes
    • ordersinteger
      Example: 38
    • revenuestring
      Example: 4826.50
    • average_order_valuestring
      Example: 127.01
    • unique_customersinteger
      Example: 35
    • signupsinteger
      Example: 412
    • notifications_sentinteger
      Example: 296
    • emails_sentinteger
      Example: 241
    • sms_sentinteger
      Example: 55

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/back_in_stock/reports/summary
curl "https://app.stoqapp.com/api/v2/external/back_in_stock/reports/summary" \
  -H "X-Auth-Token: $STOQ_API_KEY"
Response
{
  "window": {
    "from": "2026-06-01T00:00:00-04:00",
    "to": "2026-06-30T23:59:59-04:00"
  },
  "currency": "USD",
  "totals": {
    "orders": 38,
    "revenue": "4826.50",
    "average_order_value": "127.01",
    "unique_customers": 35,
    "signups": 412,
    "notifications_sent": 296,
    "emails_sent": 241,
    "sms_sent": 55
  }
}