Stats

Outcomes grouped by a column

The same outcome counts as the summary, over exactly the days asked for, one row per value of group_by, largest first. project and api_key rows carry the name as label. A deleted key's checks lose their key, so they join the row whose key is null. key is null for checks with no value in that column, such as a check nothing answered, which has no method. 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/breakdown

Request

  • Base URL: https://api.tessio.eu
  • URL: https://api.tessio.eu/v1/stats/breakdown
  • 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.

group_by'api_key' | 'format' | 'method' | 'mode' | 'project' | 'transport' required

The column to group by.

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'
groupBy'api_key' | 'format' | 'method' | 'mode' | 'project' | 'transport'

Changes

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