CHchecklyhq
Analytics

Browser checks

Changed on

Fetch detailed availability metrics and aggregated or non-aggregated Browser Check metrics across custom time ranges. For example, you can get the average amount of console errors, the p99 of your FCP and the standard deviation of your TTFB for the second page in your Browser check with one API call.

Rate-limiting is applied to this endpoint, you can send 30 requests / 60 seconds at most.

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

Request

Path parameters

idstring uuid 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".

tostring date

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.

aggregationIntervalnumber

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

Example:1440
filterByStatusstring[]

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

[
  "failure"
]
groupBy'runLocation' | 'pageIndex'

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 Browser Checks. You can pass multiple metrics as a comma separated string.

limitinteger

Limit the number of results

pagenumber

Page number

Headers

x-checkly-accountstring uuid

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

Response

Success

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

Changes

  • bc90d1bfa738Revision changes
    • info

      added the optional property to the response with the status

    • info

      added the optional property to the response with the status

    • info

      added the optional property to the response with the status

    • info

      added the optional property to the response with the status

    • info

      added the optional property to the response with the status

  • 87d29dc7b4feRevision changes
    • breaking

      for the path request parameter id, the minLength was increased from 0 to 1

    • breaking

      for the header request parameter x-checkly-account, the format changed from no format to uuid

    • breaking

      for the path request parameter id, the format changed from no format to uuid

    • breaking

      the response's property format changed from date to date-time for status

    • breaking

      the / response's property type changed from string to object for status

    • breaking

      the response's property format changed from date to date-time for status

    • warning

      for the query request parameter page, the exclusiveMinimum was set to true

    • warning

      for the query request parameter page, the min was set to 0.00

    • warning

      removed the optional property from the response with the status

    • warning

      removed the optional property from the response with the status

    • info

      added the non-success response with the status

    • info

      added the non-success response with the status

    • info

      the response property became required for the status

    • info

      the response property became required for the status

    • info

      the response property became required for the status

    • info

      removed the 401.00 enum value from the response property for the response status

    • info

      removed the 403.00 enum value from the response property for the response status

    • info

      removed the 429.00 enum value from the response property for the response status

    • info

      removed the Forbidden enum value from the response property for the response status

    • info

      removed the Too Many Requests enum value from the response property for the response status

    • info

      removed the Unauthorized enum value from the response property for the response status

    • info

      added the required property // to the response with the status