Stats

Platform snapshot (counts, plan mix, content, traffic, deltas)

Admin-only point-in-time snapshot: headline counts, plan mix, content + traffic totals, and trailing-window deltas — everything the Overview tab shows except the growth series (see GET /stats/growth). Aggregate-only. Served from a short server-side cache.

get/stats/overview

Request

  • Base URL: https://api.nippy.host
  • URL: https://api.nippy.host/stats/overview
  • Auth: bearer (a scheme the document does not define)

Query parameters

fromstring

Window start, ISO 8601. Omit for the trailing 30 days; pass an explicit start (or all-time via a very early date) to widen the growth charts.

tostring

Window end, ISO 8601. Defaults to now; clamped to now.

interval'1m' | '5m' | '15m' | '1h' | '3h' | '6h' | '1d' | '1w'

Growth-series bucket width (spacing between points). Must be one of the widths allowed for the window's duration; an unsupported value is clamped to that duration's default.

tzOffsetnumber

Viewer's UTC offset in minutes, east-positive (-new Date().getTimezoneOffset()). Growth buckets are aligned to the viewer’s local day/week boundaries using this. Defaults to 0 (UTC).

Response

windowDaysnumber required

Window the traffic figures cover, in days.

fromstring required

Start of the windowed traffic figures (ISO 8601).

tostring required

End of the windowed traffic figures (ISO 8601).

generatedAtstring required

When this snapshot was computed (ISO 8601).

Example response

{
  "attribution": {
    "signupsByRef": [
      {
        "key": "cli"
      }
    ],
    "tokensByVia": [
      {
        "key": "cli"
      }
    ],
    "deploysByPlatform": [
      {
        "key": "cli"
      }
    ]
  }
}

Changes

No recorded changes to this operation across all 1 revision of this API.