v2

latestOpenAPI 3.0.02026-07-261859071.2 MB
Analytics

Playwright checks

Fetch detailed availability metrics and aggregated or non-aggregated Playwright Check metrics across custom time ranges. Rate-limiting is applied to this endpoint, you can send 30 requests / 60 seconds at most.

get/v1/analytics/playwright-checks/{id}

Path parameters

idstring required

Query parameters

fromstring date

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

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

tostring date

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

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

quickRange'last24Hours' | 'last7Days' | 'last30Days' | 'thisWeek' | 'thisMonth' | 'lastWeek' | 'lastMonth'

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

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

aggregationIntervalnumber

The time interval to use for aggregating metrics in minutes. For example, five minutes is 5, 24 hours is 1440.

Example:1440

The time interval to use for aggregating metrics in minutes. For example, five minutes is 5, 24 hours is 1440.

filterByStatusstring[]

Filter based on whether a check result was either failing or passing

Filter based on whether a check result was either failing or passing

[
  "failure"
]
groupBy'runLocation'

Determines how the series data is grouped. Note that grouped queries are a bit more expensive and might take longer.

Determines how the series data is grouped. Note that grouped queries are a bit more expensive and might take longer.

metricsstring[] required

Available metrics for Playwright Checks. You can pass multiple metrics as a comma separated string.

Available metrics for Playwright Checks. You can pass multiple metrics as a comma separated string.

limitinteger

Limit the number of results

Limit the number of results

pagenumber

Page number

Page number

Headers

x-checkly-accountstring

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

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

Response

Success

checkIdstring
namestring
checkType'AGENTIC' | 'API' | 'BROWSER' | 'HEARTBEAT' | 'ICMP' | 'MULTI_STEP' | 'TCP' | 'PLAYWRIGHT' | 'TRACEROUTE' | 'URL' | 'DNS' | 'SSL' | 'GRPC'
activatedboolean
mutedboolean
frequencynumber
fromstring date
tostring date
tagsstring[]
seriesstring[]