stats

Returns the caller's usage overview: verdict breakdown, activity series, check usage, and totals.

get/api/stats/overview

Request

  • Base URL: https://api.pricklymails.com (the document declares no server; this is the origin it was published from)
  • URL: https://api.pricklymails.com/api/stats/overview
  • Auth: one of:
    • HTTP bearer
    • HTTP bearer

Query parameters

granularitystring

Bucket width for the activity time series: hour, day, week, or month (default day).

daysinteger

Number of whole buckets the activity window covers at the chosen granularity, ending with the current, still-open bucket (default 28, clamped to 1..=364): 8 at day gives 8 buckets, 1 at hour gives 24, 364 at month gives 12.

Response

Verdict breakdown, activity series, check usage, and totals.

Changes

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