Analytics

Get analytics summary for multiple checks

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

Query parameters

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

Time range for analytics.

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

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

Changed in 1 of the 4 revisions of this API.4210

  • 87d29dc7b4fe4210See the full diff
    • request body became required

      request-body-became-required

    • for the header request parameter x-checkly-account, the type/format was changed from string/ to string/uuid

      request-parameter-type-changed

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

      request-property-min-length-increased

    • the checkIds/items/ request property type/format changed from string/ to string/uuid

      request-property-type-changed

    • removed the optional property attributes from the response with the 401 status

      response-optional-property-removed

    • removed the optional property attributes from the response with the 429 status

      response-optional-property-removed

    • added the non-success response with the status 400

      response-non-success-status-added

    • the response property message became required for the status 401

      response-property-became-required

    • the response property message became required for the status 403

      response-property-became-required

    • the response property message became required for the status 429

      response-property-became-required

    • removed the 401.00 enum value from the statusCode response property for the response status 401

      response-property-enum-value-removed

    • removed the 403.00 enum value from the statusCode response property for the response status 403

      response-property-enum-value-removed

    • removed the 429.00 enum value from the statusCode response property for the response status 429

      response-property-enum-value-removed

    • removed the Forbidden enum value from the error response property for the response status 403

      response-property-enum-value-removed

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

      response-property-enum-value-removed

    • removed the Unauthorized enum value from the error response property for the response status 401

      response-property-enum-value-removed

    This revision also has 566 changes that name no endpoint, such as unreferenced schemas being removed. See the revision's changelog