We are adding a new API to enable more fine grained data acces. This will be a big change, so it is versioned under v2. Furthermore we do not want polymorphic behaviour as it complicates schema handling. This means the endpoints would be
/v2/reporting/api/{id}
/v2/reporting/browser/{id}
Query patterns
Non-aggregated data
default behaviour (not setting an aggregationPeriod) returns raw check run data.
Aggregated data
Setting a aggregationPeriod forces aggregating the metrics. Every metric selected must be accompanied by a aggregation type, which default to avg
Metrics psuedo-object
TTFB is the base notation. Just a string that represents the metric.
TTFB_p95 adds an aggregation type, e.g. consoleErrors_sum
Filters
tags : only makes sense in list context, not individual checks.
deactivated : only makes sense in list context, not individual checks.
tnolet
commented
1 year ago
We are adding a new API to enable more fine grained data acces. This will be a big change, so it is versioned under
v2. Furthermore we do not want polymorphic behaviour as it complicates schema handling. This means the endpoints would be/v2/reporting/api/{id}/v2/reporting/browser/{id}Query patterns
Non-aggregated data
aggregationPeriod) returns raw check run data.Aggregated data
aggregationPeriodforces aggregating the metrics. Everymetricselected must be accompanied by aaggregationtype, which default toavgMetrics psuedo-object
TTFBis the base notation. Just a string that represents the metric.TTFB_p95adds anaggregationtype, e.g.consoleErrors_sumFilters
tags: only makes sense in list context, not individual checks.deactivated: only makes sense in list context, not individual checks.statusThe first endpoint is live under alpha:
https://developers.checklyhq.com/reference/getv2reportingbrowserchecksid