CHchecklyhq
Analytics

Get analytics summary for multiple checks

Changed on

Returns availability, response times, and latency metrics for the given checks. Response shape is polymorphic per check type: fields are present only when the metric applies to that type. A null value means no data in the requested time range; an absent field means the metric does not apply to that check type.

Currently only quickRange is supported for time filtering. Arbitrary from/to date ranges are not yet supported but may be added in a future release.

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

post/v1/analytics/checks

Request

Query parameters

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

Time range for analytics.

Headers

x-checkly-accountstring uuid

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

Request body

checkIdsstring[] required

Array of check IDs to fetch analytics for. Each ID must be a UUIDv4.

Response

Successful

checkIdstring uuid required
checkType'AGENTIC' | 'API' | 'BROWSER' | 'HEARTBEAT' | 'ICMP' | 'MULTI_STEP' | 'TCP' | 'PLAYWRIGHT' | 'TRACEROUTE' | 'URL' | 'DNS' | 'SSL' | 'GRPC' required
availabilitynumber nullable
responseTime_avgnumber nullable
responseTime_p50number nullable
responseTime_p95number nullable
responseTime_p99number nullable
latency_avgnumber nullable
latency_p50number nullable
latency_p95number nullable
latency_p99number nullable
packetLoss_avgnumber nullable
packetLoss_p95number nullable
packetLoss_p99number nullable
hopCount_avgnumber nullable

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

  • 87d29dc7b4feRevision changes
    • breaking

      request body became required

    • breaking

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

    • breaking

      the / request property's minLength was increased from 0 to 1

    • breaking

      the / request property format changed from no format to uuid

    • 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

      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