Generates a report with aggregate statistics for checks and check groups.
GET {{baseUrl}}/v1/reporting?from=1987-11-28&to=1987-11-28&presetWindow=last24Hrs&deactivated=false
Generates a report with aggregated statistics for all checks or a filtered set of checks over a specified time window.
Request Params
| Key | Datatype | Required | Description |
|---|---|---|---|
from | string | Custom start time of reporting window in unix timestamp format. Setting a custom "from" timestamp overrides the use of any "presetWindow". | |
to | string | Custom end time of reporting window in unix timestamp format. Setting a custom "to" timestamp overrides the use of any "presetWindow". | |
presetWindow | string | Preset reporting windows are used for quickly generating report on commonly used windows. Can be overridden by using a custom "to" and "from" timestamp. | |
deactivated | boolean | Filter checks by activated status. |
HEADERS
| Key | Datatype | Required | Description |
|---|---|---|---|
x-checkly-account | string | Your Checkly account ID, you can find it at https://app.checklyhq.com/settings/account/general | |
Accept | string |
RESPONSES
status: OK
[{"name":"API Check","checkId":"6d3ad736-3f9c-4b2c-9b19-dea0386f6ed7","checkType":"API","deactivated":false,"tags":["production"],"aggregate":{"successRatio":{"value":"\u003cError: Too many levels of nesting to fake this schema\u003e"},"avg":{"value":"\u003cError: Too many levels of nesting to fake this schema\u003e"},"p95":{"value":"\u003cError: Too many levels of nesting to fake this schema\u003e"},"p99":{"value":"\u003cError: Too many levels of nesting to fake this schema\u003e"}}},{"name":"API Check","checkId":"6d3ad736-3f9c-4b2c-9b19-dea0386f6ed7","checkType":"API","deactivated":false,"tags":["production"],"aggregate":{"successRatio":{"value":"\u003cError: Too many levels of nesting to fake this schema\u003e"},"avg":{"value":"\u003cError: Too many levels of nesting to fake this schema\u003e"},"p95":{"value":"\u003cError: Too many levels of nesting to fake this schema\u003e"},"p99":{"value":"\u003cError: Too many levels of nesting to fake this schema\u003e"}}}]