API Reference

Generates a report with aggregate statistics for checks and check groups.

get
https://api.checklyhq.com/v1/reporting

Generates a report with aggregated statistics for all checks or a filtered set of checks over a specified time window.

Query Params
date

Custom start time of reporting window in unix timestamp format. Setting a custom "from" timestamp overrides the use of any "quickRange".

date

Custom end time of reporting window in unix timestamp format. Setting a custom "to" timestamp overrides the use of any "quickRange".

string
enum
Defaults to last24Hrs

Preset reporting windows are used for quickly generating report on commonly used windows. Can be overridden by using a custom "to" and "from" timestamp.

Allowed:
filterByTags
array of strings

Use tags to filter the checks you want to see in your report.

filterByTags
boolean
Defaults to null

Filter checks by activated status. When set to true, only deactivated checks are returned. When set to false, only activated checks are returned. When omitted, all checks are returned.

Headers
string

Your Checkly account ID, you can find it at https://app.checklyhq.com/settings/account/general

Responses

Updated 7 months ago

Language
Credentials
Header
Response 
Click Try It! to start a request and see the response here! Or choose an example:
application/json
Updated 7 months ago