Get the report summary
API v2 is in public beta: endpoints and fields can change before general availability. See the changelog
/back_in_stock/reports/summaryCosts 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
fromstringStart 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.
tostringEnd 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.
rangestringSet to all_time for the shop's whole history instead of from/to.
One ofall_time
Returns
windowobject, nullableThe date range the figures cover. Null when range is all_time.
Show 2 child attributesHide child attributes
fromstringStart of the range, ISO 8601.
tostringEnd of the range, ISO 8601.
currencynullISO 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.
totalsobjectShow 8 child attributesHide child attributes
ordersintegerExample:38revenuestringExample:4826.50average_order_valuestringExample:127.01unique_customersintegerExample:35signupsintegerExample:412notifications_sentintegerExample:296emails_sentintegerExample:241sms_sentintegerExample:55
Errors
validation_failedThe 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.
curl "https://app.stoqapp.com/api/v2/external/back_in_stock/reports/summary" \
-H "X-Auth-Token: $STOQ_API_KEY"const res = await fetch("https://app.stoqapp.com/api/v2/external/back_in_stock/reports/summary", {
headers: {
"X-Auth-Token": process.env.STOQ_API_KEY,
},
});
const data = await res.json();import os
import requests
res = requests.get(
"https://app.stoqapp.com/api/v2/external/back_in_stock/reports/summary",
headers={"X-Auth-Token": os.environ["STOQ_API_KEY"]},
)
data = res.json()require "net/http"
require "json"
uri = URI("https://app.stoqapp.com/api/v2/external/back_in_stock/reports/summary")
req = Net::HTTP::Get.new(uri, "X-Auth-Token" => ENV["STOQ_API_KEY"])
res = Net::HTTP.start(uri.host, uri.port, use_ssl: true) { |http| http.request(req) }
data = JSON.parse(res.body)curl "https://app.stoqapp.com/api/v2/external/back_in_stock/reports/summary?range=all_time" \
-H "X-Auth-Token: $STOQ_API_KEY"const res = await fetch("https://app.stoqapp.com/api/v2/external/back_in_stock/reports/summary?range=all_time", {
headers: {
"X-Auth-Token": process.env.STOQ_API_KEY,
},
});
const data = await res.json();import os
import requests
res = requests.get(
"https://app.stoqapp.com/api/v2/external/back_in_stock/reports/summary?range=all_time",
headers={"X-Auth-Token": os.environ["STOQ_API_KEY"]},
)
data = res.json()require "net/http"
require "json"
uri = URI("https://app.stoqapp.com/api/v2/external/back_in_stock/reports/summary?range=all_time")
req = Net::HTTP::Get.new(uri, "X-Auth-Token" => ENV["STOQ_API_KEY"])
res = Net::HTTP.start(uri.host, uri.port, use_ssl: true) { |http| http.request(req) }
data = JSON.parse(res.body){
"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
}
}{
"errors": [
"Invalid API key"
],
"code": "auth_invalid",
"details": [
{
"code": "auth_invalid",
"message": "Invalid API key",
"path": null,
"value": null,
"expected": null
}
]
}{
"errors": [
"name is required"
],
"code": "validation_failed",
"details": [
{
"code": "validation_failed",
"message": "name is required",
"path": null,
"value": null,
"expected": null
}
]
}{
"errors": [
"Rate limit exceeded"
],
"code": "rate_limited",
"details": [
{
"code": "rate_limited",
"message": "Rate limit exceeded",
"path": null,
"value": null,
"expected": null
}
]
}