Stats

One metric over time, with zeros for empty buckets

One point per bucket from from to to, a bucket with no checks included as zero, so a chart never has to fill gaps. The granularity follows the range as on the Stats page, except that a range of two days or less is cut into hours, labelled YYYY-MM-DDTHH:00Z and ending at the current hour. Weeks and months are UTC calendar steps. pass_rate is null for a bucket where nothing ended. Under a project's key, over its project; under an organisation's key, over every project in it, or one with project_id. UTC days. Any key may call it, of either scope; each key spends its own budget.

get/v1/stats/timeseries

Request

  • Base URL: https://api.tessio.eu
  • URL: https://api.tessio.eu/v1/stats/timeseries
  • Auth: HTTP bearer

Query parameters

fromstring date

The first day, inclusive. A start further back than two years is refused rather than narrowed, so an answer never covers a shorter range than the one asked for.

Omitting both from and to gives the default window, the last 30 days. Omitting only from is a half-written request and is refused.

tostring date

The last day, inclusive. Defaults to today, and an end in the future is pulled back to today, so a preset like "this year" does not draw empty months that read as an outage.

mode'all' | 'live' | 'test'

Live checks, test checks or both. Defaults to live at org scope (an organisation's key included), which is what a customer's own numbers are, and to the project's own mode at project scope (a project's key included), so a test project reads its checks.

metric'checks' | 'expired' | 'failed' | 'pass_rate' | 'passed' | 'under_age'

What each point counts. Defaults to checks, every check created in the bucket.

project_idstring uuid

Only this project of the org. A project of another org is refused exactly as one that does not exist, invalid_project_id. Under a project's key, only that project may be named.

Response

OK

mode'all' | 'live' | 'test'
metric'checks' | 'expired' | 'failed' | 'pass_rate' | 'passed' | 'under_age'
granularity'day' | 'hour' | 'month' | 'week'

Changes

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