GET
/
v1
/
reporting
Generates a report with aggregate statistics for checks and check groups.
curl --request GET \
  --url https://api.checklyhq.com/v1/reporting \
  --header 'Authorization: <api-key>'
[
  {
    "name": "API Check",
    "checkId": "d2881e09-411b-4c8d-84b8-fe05fbca80b6",
    "checkType": "API",
    "deactivated": false,
    "tags": [
      "production"
    ],
    "aggregate": {
      "successRatio": 50,
      "avg": 100,
      "p95": 200,
      "p99": 100
    }
  }
]

​
Overview

The Generate Report endpoint creates comprehensive monitoring reports based on your check data, analytics, and performance metrics. Use this endpoint to generate custom reports for stakeholders, compliance, and performance analysis. Common Use Cases:
  • Performance Reporting
  • Compliance Documentation
  • Stakeholder Updates
  • Trend Analysis
Report generation may take time for large datasets. Consider using appropriate time ranges and filters to optimize report generation performance.

Authorizations

​
Authorization
string
header
required

The Checkly Public API uses API keys to authenticate requests. You can get the API Key here.

Your API key is like a password: keep it secure!

Authentication to the API is performed using the Bearer auth method in the Authorization header and using the account ID.

For example, set Authorization header while using cURL:

curl -H "Authorization: Bearer [apiKey]" "X-Checkly-Account: [accountId]"

Headers

​
x-checkly-account
string

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

Query Parameters

​
from
string<date>

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

​
to
string<date>

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

​
quickRange
enum<string>
default: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.

Available options:
last24Hrs,
last7Days,
last30Days,
thisWeek,
thisMonth,
lastWeek,
lastMonth
​
filterByTags
string[]

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

​
deactivated
boolean
default:false

Filter checks by activated status.

Response

Successful

​
name
string
required

Check name.

Example:

"API Check"

​
checkId
string
required

Check ID.

Example:

"d2881e09-411b-4c8d-84b8-fe05fbca80b6"

​
checkType
string
required

Check type.

Example:

"API"

​
deactivated
boolean
default:false
required

Check deactivated.

​
tags
string[]
required

Check tags.

Example:
["production"]
​
aggregate
object