QR template statistics

Overview

Get aggregate QR template counts for the authenticated user's company — total templates, a breakdown by template type, and a count of those created in the last 30 days. Optionally scoped by store and/or created_at date range.

Prerequisites

  • A bearer token. Callable with Account tokens.

Base URL

EnvironmentURL
Productionhttps://production-api.shoutaboutus.com
Developmenthttps://development-api.shoutaboutus.com

Endpoint

GET /api/v1/qr-codes/template/stats

Authentication

  • Requires a bearer token in the Authorization: Bearer <bearer-token> header.

  • Who can call it: Account tokens.

  • All aggregates cover only (own company).

  • The optional store_id must also sit inside your own account tree.

Rate limit

  • No rate limit.

Query parameters

  • Query: store_id (integer, optional) — must be an existing location and belong to the auth company (an ownership check).
  • Query: start_date (string Y-m-d, optional) — the earliest created_at to include; swapped with end_date when the two are reversed.
  • Query: end_date (string Y-m-d, optional) — the latest created_at to include.

Response

  • data.status (string) — "success".
  • data.data (object):
  • total_templates (integer) — count matching the scope/filters.
  • by_template_type (object) — map of template_type → count (only types present appear as keys).
  • recently_created (integer) — count with created_at >= now-30 days (within the same scope).
  • data.message (string) — "QR code template statistics retrieved successfully".

200 OK · 200

{
  "data": {
    "status": "success",
    "data": {
      "total_templates": 25,
      "by_template_type": { "standard": 15, "hangtag": 7, "custom": 3 },
      "recently_created": 3
    },
    "message": "QR code template statistics retrieved successfully"
  }
}

Errors

StatusMeaning
401The bearer token is missing, expired or invalid
422The request failed validation — the response names the fields
500Unexpected server error

Example request

curl --request GET \
  --url "https://production-api.shoutaboutus.com/api/v1/qr-codes/template/stats" \
  --header 'Authorization: Bearer <bearer-token>' \
  --header 'Accept: application/json'

Did this page help you?