Get the conversions report
API v2 is in public beta: endpoints and fields can change before general availability. See the changelog
/back_in_stock/reports/conversionsCosts 1 rate-limit point · Rate limits
The Back in stock Overview orders chart: orders attributed to back-in-stock alerts and their revenue per day, week or month.
The same points as the dashboard chart, counted live: orders attributed at medium or high confidence. interval is daily up to 60 days, weekly up to 180, then monthly, and buckets are UTC days as on the chart. range=all_time is the dashboard's All time.
Also searched asdid the alerts convertrecovered revenueconversion trendorders from alertsrevenue recovered over time
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.
intervalstringExample:stringcurrencynullISO 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.
seriesarray of objectsShow 3 child attributesHide child attributes
datestringExample:2026-01-15ordersintegerExample:1revenuestringExample:string
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/conversions" \
-H "X-Auth-Token: $STOQ_API_KEY"const res = await fetch("https://app.stoqapp.com/api/v2/external/back_in_stock/reports/conversions", {
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/conversions",
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/conversions")
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/conversions?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/conversions?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/conversions?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/conversions?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-01-15T09:30:00Z",
"to": "2026-01-15T09:30:00Z"
},
"interval": "string",
"currency": null,
"series": [
{
"date": "2026-01-15",
"orders": 1,
"revenue": "string"
}
]
}{
"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
}
]
}