GET /v1/stats/summary
Outcomes, rates and time to result for a period, beside the period before it
Exactly the days asked for, and the period of equal length just before them, so a client can show a change without a second request. Rates are over the checks that ended (passed, under age, failed, expired), so a check still pending moves no rate; each is null when nothing ended. p50Seconds and p95Seconds run from creation to completion, over completed checks only. retention says from which day the plan keeps every check. 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.
| Parameter | In | Type | Description |
|---|---|---|---|
from | query | string (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 |
to | query | string (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 | query | string | Live checks, test checks or both. Defaults to |
project_id | query | string (uuid) | Only this project of the org. A project of another org is refused exactly as one that does not exist, |
| Response | Body | Description |
|---|---|---|
200 | AgeCheckStatsSummary | OK |
400 | Error | The range is refused as for every chart (invalid_from, invalid_to, range_inverted, range_too_old, range_too_long), or invalid_mode, invalid_metric, invalid_group_by or invalid_project_id. Checked before the plan, so a malformed request is never answered with an upgrade. |
401 | - | No key, or one that is unknown or revoked |
403 | PlanFeatureUnavailable | plan_feature_unavailable. The org's plan does not include this read. Every plan reads the summary, Starter adds the time series, Growth and above read all five. |
429 | Error | rate_limited: this key's budget is spent. Header |