Skip to content

Get the signups report

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

GET/back_in_stock/reports/signups

Costs 1 rate-limit point · Rate limits

The Back in stock Overview signups chart: back-in-stock signups created per day, week or month.

The same points as the dashboard chart. One signup is one person waiting on one variant, so email and SMS for the same variant count once. 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 assignup trendsignups over timewaitlist growthnew signupsdaily signups

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

    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.

  • intervalstring
    Example: string
  • seriesarray of objects
    Show 2 child attributesHide child attributes
    • datestring
      Example: 2026-01-15
    • signupsinteger
      Example: 1

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/signups
curl "https://app.stoqapp.com/api/v2/external/back_in_stock/reports/signups" \
  -H "X-Auth-Token: $STOQ_API_KEY"
Response
{
  "window": {
    "from": "2026-01-15T09:30:00Z",
    "to": "2026-01-15T09:30:00Z"
  },
  "interval": "string",
  "series": [
    {
      "date": "2026-01-15",
      "signups": 1
    }
  ]
}