Analytics

List all available reporting metrics.

List all available reporting metrics.

get/v1/analytics/metrics

Query parameters

checkType'AGENTIC' | 'API' | 'BROWSER' | 'HEARTBEAT' | 'ICMP' | 'MULTI_STEP' | 'TCP' | 'PLAYWRIGHT' | 'TRACEROUTE' | 'URL' | 'DNS' | 'SSL' | 'GRPC' required

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

Response

Successful

namestring required
unit'milliseconds' | 'score' | 'count' | 'percentage' required
labelstring required
type'Array' | 'Int' | 'Integer' | 'Float' | 'String'
aggregatedboolean required

Changes

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

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

      request-parameter-type-changed

    • the items/ response's property type/format changed from string/ to object/ for status 200

      response-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

    • added the optional property items/type to the response with the 200 status

      response-optional-property-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

    • added the required property items/aggregated to the response with the 200 status

      response-required-property-added

    • added the required property items/label to the response with the 200 status

      response-required-property-added

    • added the required property items/name to the response with the 200 status

      response-required-property-added

    • added the required property items/unit to the response with the 200 status

      response-required-property-added

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