Analytics

SSL monitors

Fetch detailed availability metrics and aggregated or non-aggregated SSL Monitor metrics across custom time ranges. For example, you can get the p99 and p95 of the TLS handshake time together with the availability percentage for any time range. Rate-limiting is applied to this endpoint, you can send 30 requests / 60 seconds at most.

get/v1/analytics/ssl/{id}

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

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

Available metrics for SSL Monitors. 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 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

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

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

  • 87d29dc7b4fe65124See the full diff
    • for the path request parameter id, the minLength was increased from 0 to 1

      request-parameter-min-length-increased

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

      request-parameter-type-changed

    • for the path request parameter id, the type/format was changed from string/ to string/uuid

      request-parameter-type-changed

    • the from response's property type/format changed from string/date to string/date-time for status 200

      response-property-type-changed

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

      response-property-type-changed

    • the to response's property type/format changed from string/date to string/date-time for status 200

      response-property-type-changed

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

      request-parameter-exclusive-min-set

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

      request-parameter-min-set

    • 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

    • removed the optional property metadata/string from the response with the 200 status

      response-optional-property-removed

    • added the non-success response with the status 400

      response-non-success-status-added

    • added the non-success response with the status 404

      response-non-success-status-added

    • added the optional property metadata/availability to the response with the 200 status

      response-optional-property-added

    • added the optional property metadata/baselineGrade to the response with the 200 status

      response-optional-property-added

    • added the optional property metadata/baselineGrade_avg to the response with the 200 status

      response-optional-property-added

    • added the optional property metadata/baselineGrade_max to the response with the 200 status

      response-optional-property-added

    • added the optional property metadata/baselineGrade_median to the response with the 200 status

      response-optional-property-added

    • added the optional property metadata/baselineGrade_min to the response with the 200 status

      response-optional-property-added

    • added the optional property metadata/baselineGrade_p50 to the response with the 200 status

      response-optional-property-added

    • added the optional property metadata/baselineGrade_p90 to the response with the 200 status

      response-optional-property-added

    • added the optional property metadata/baselineGrade_p95 to the response with the 200 status

      response-optional-property-added

    • added the optional property metadata/baselineGrade_p99 to the response with the 200 status

      response-optional-property-added

    • added the optional property metadata/baselineGrade_stddev to the response with the 200 status

      response-optional-property-added

    • added the optional property metadata/baselineGrade_sum to the response with the 200 status

      response-optional-property-added

    • added the optional property metadata/baselineVerdict to the response with the 200 status

      response-optional-property-added

    • added the optional property metadata/baselineVerdict_avg to the response with the 200 status

      response-optional-property-added

    • added the optional property metadata/baselineVerdict_max to the response with the 200 status

      response-optional-property-added

    • added the optional property metadata/baselineVerdict_median to the response with the 200 status

      response-optional-property-added

    • added the optional property metadata/baselineVerdict_min to the response with the 200 status

      response-optional-property-added

    • added the optional property metadata/baselineVerdict_p50 to the response with the 200 status

      response-optional-property-added

    • added the optional property metadata/baselineVerdict_p90 to the response with the 200 status

      response-optional-property-added

    • added the optional property metadata/baselineVerdict_p95 to the response with the 200 status

      response-optional-property-added

    • added the optional property metadata/baselineVerdict_p99 to the response with the 200 status

      response-optional-property-added

    • added the optional property metadata/baselineVerdict_stddev to the response with the 200 status

      response-optional-property-added

    • added the optional property metadata/baselineVerdict_sum to the response with the 200 status

      response-optional-property-added

    • added the optional property metadata/chainTrusted to the response with the 200 status

      response-optional-property-added

    • added the optional property metadata/chainTrusted_avg to the response with the 200 status

      response-optional-property-added

    • added the optional property metadata/chainTrusted_max to the response with the 200 status

      response-optional-property-added

    • added the optional property metadata/chainTrusted_median to the response with the 200 status

      response-optional-property-added

    • added the optional property metadata/chainTrusted_min to the response with the 200 status

      response-optional-property-added

    • added the optional property metadata/chainTrusted_p50 to the response with the 200 status

      response-optional-property-added

    • added the optional property metadata/chainTrusted_p90 to the response with the 200 status

      response-optional-property-added

    • added the optional property metadata/chainTrusted_p95 to the response with the 200 status

      response-optional-property-added

    • added the optional property metadata/chainTrusted_p99 to the response with the 200 status

      response-optional-property-added

    • added the optional property metadata/chainTrusted_stddev to the response with the 200 status

      response-optional-property-added

    • added the optional property metadata/chainTrusted_sum to the response with the 200 status

      response-optional-property-added

    • added the optional property metadata/cipherSuite to the response with the 200 status

      response-optional-property-added

    • added the optional property metadata/cipherSuite_avg to the response with the 200 status

      response-optional-property-added

    • added the optional property metadata/cipherSuite_max to the response with the 200 status

      response-optional-property-added

    • added the optional property metadata/cipherSuite_median to the response with the 200 status

      response-optional-property-added

    • added the optional property metadata/cipherSuite_min to the response with the 200 status

      response-optional-property-added

    • added the optional property metadata/cipherSuite_p50 to the response with the 200 status

      response-optional-property-added

    • added the optional property metadata/cipherSuite_p90 to the response with the 200 status

      response-optional-property-added

    • added the optional property metadata/cipherSuite_p95 to the response with the 200 status

      response-optional-property-added

    • added the optional property metadata/cipherSuite_p99 to the response with the 200 status

      response-optional-property-added

    • added the optional property metadata/cipherSuite_stddev to the response with the 200 status

      response-optional-property-added

    • added the optional property metadata/cipherSuite_sum to the response with the 200 status

      response-optional-property-added

    • added the optional property metadata/daysUntilExpiry to the response with the 200 status

      response-optional-property-added

    • added the optional property metadata/daysUntilExpiry_avg to the response with the 200 status

      response-optional-property-added

    • added the optional property metadata/daysUntilExpiry_max to the response with the 200 status

      response-optional-property-added

    • added the optional property metadata/daysUntilExpiry_median to the response with the 200 status

      response-optional-property-added

    • added the optional property metadata/daysUntilExpiry_min to the response with the 200 status

      response-optional-property-added

    • added the optional property metadata/daysUntilExpiry_p50 to the response with the 200 status

      response-optional-property-added

    • added the optional property metadata/daysUntilExpiry_p90 to the response with the 200 status

      response-optional-property-added

    • added the optional property metadata/daysUntilExpiry_p95 to the response with the 200 status

      response-optional-property-added

    • added the optional property metadata/daysUntilExpiry_p99 to the response with the 200 status

      response-optional-property-added

    • added the optional property metadata/daysUntilExpiry_stddev to the response with the 200 status

      response-optional-property-added

    • added the optional property metadata/daysUntilExpiry_sum to the response with the 200 status

      response-optional-property-added

    • added the optional property metadata/handshakeTimeMs to the response with the 200 status

      response-optional-property-added

    • added the optional property metadata/handshakeTimeMs_avg to the response with the 200 status

      response-optional-property-added

    • added the optional property metadata/handshakeTimeMs_max to the response with the 200 status

      response-optional-property-added

    • added the optional property metadata/handshakeTimeMs_median to the response with the 200 status

      response-optional-property-added

    • added the optional property metadata/handshakeTimeMs_min to the response with the 200 status

      response-optional-property-added

    • added the optional property metadata/handshakeTimeMs_p50 to the response with the 200 status

      response-optional-property-added

    • added the optional property metadata/handshakeTimeMs_p90 to the response with the 200 status

      response-optional-property-added

    • added the optional property metadata/handshakeTimeMs_p95 to the response with the 200 status

      response-optional-property-added

    • added the optional property metadata/handshakeTimeMs_p99 to the response with the 200 status

      response-optional-property-added

    • added the optional property metadata/handshakeTimeMs_stddev to the response with the 200 status

      response-optional-property-added

    • added the optional property metadata/handshakeTimeMs_sum to the response with the 200 status

      response-optional-property-added

    • added the optional property metadata/hostnameVerified to the response with the 200 status

      response-optional-property-added

    • added the optional property metadata/hostnameVerified_avg to the response with the 200 status

      response-optional-property-added

    • added the optional property metadata/hostnameVerified_max to the response with the 200 status

      response-optional-property-added

    • added the optional property metadata/hostnameVerified_median to the response with the 200 status

      response-optional-property-added

    • added the optional property metadata/hostnameVerified_min to the response with the 200 status

      response-optional-property-added

    • added the optional property metadata/hostnameVerified_p50 to the response with the 200 status

      response-optional-property-added

    • added the optional property metadata/hostnameVerified_p90 to the response with the 200 status

      response-optional-property-added

    • added the optional property metadata/hostnameVerified_p95 to the response with the 200 status

      response-optional-property-added

    • added the optional property metadata/hostnameVerified_p99 to the response with the 200 status

      response-optional-property-added

    • added the optional property metadata/hostnameVerified_stddev to the response with the 200 status

      response-optional-property-added

    • added the optional property metadata/hostnameVerified_sum to the response with the 200 status

      response-optional-property-added

    • added the optional property metadata/keySizeBits to the response with the 200 status

      response-optional-property-added

    • added the optional property metadata/keySizeBits_avg to the response with the 200 status

      response-optional-property-added

    • added the optional property metadata/keySizeBits_max to the response with the 200 status

      response-optional-property-added

    • added the optional property metadata/keySizeBits_median to the response with the 200 status

      response-optional-property-added

    • added the optional property metadata/keySizeBits_min to the response with the 200 status

      response-optional-property-added

    • added the optional property metadata/keySizeBits_p50 to the response with the 200 status

      response-optional-property-added

    • added the optional property metadata/keySizeBits_p90 to the response with the 200 status

      response-optional-property-added

    • added the optional property metadata/keySizeBits_p95 to the response with the 200 status

      response-optional-property-added

    • added the optional property metadata/keySizeBits_p99 to the response with the 200 status

      response-optional-property-added

    • added the optional property metadata/keySizeBits_stddev to the response with the 200 status

      response-optional-property-added

    • added the optional property metadata/keySizeBits_sum to the response with the 200 status

      response-optional-property-added

    • added the optional property metadata/ocspStapled to the response with the 200 status

      response-optional-property-added

    • added the optional property metadata/ocspStapled_avg to the response with the 200 status

      response-optional-property-added

    • added the optional property metadata/ocspStapled_max to the response with the 200 status

      response-optional-property-added

    • added the optional property metadata/ocspStapled_median to the response with the 200 status

      response-optional-property-added

    • added the optional property metadata/ocspStapled_min to the response with the 200 status

      response-optional-property-added

    • added the optional property metadata/ocspStapled_p50 to the response with the 200 status

      response-optional-property-added

    • added the optional property metadata/ocspStapled_p90 to the response with the 200 status

      response-optional-property-added

    • added the optional property metadata/ocspStapled_p95 to the response with the 200 status

      response-optional-property-added

    • added the optional property metadata/ocspStapled_p99 to the response with the 200 status

      response-optional-property-added

    • added the optional property metadata/ocspStapled_stddev to the response with the 200 status

      response-optional-property-added

    • added the optional property metadata/ocspStapled_sum to the response with the 200 status

      response-optional-property-added

    • added the optional property metadata/retries to the response with the 200 status

      response-optional-property-added

    • added the optional property metadata/tlsVersion to the response with the 200 status

      response-optional-property-added

    • added the optional property metadata/tlsVersion_avg to the response with the 200 status

      response-optional-property-added

    • added the optional property metadata/tlsVersion_max to the response with the 200 status

      response-optional-property-added

    • added the optional property metadata/tlsVersion_median to the response with the 200 status

      response-optional-property-added

    • added the optional property metadata/tlsVersion_min to the response with the 200 status

      response-optional-property-added

    • added the optional property metadata/tlsVersion_p50 to the response with the 200 status

      response-optional-property-added

    • added the optional property metadata/tlsVersion_p90 to the response with the 200 status

      response-optional-property-added

    • added the optional property metadata/tlsVersion_p95 to the response with the 200 status

      response-optional-property-added

    • added the optional property metadata/tlsVersion_p99 to the response with the 200 status

      response-optional-property-added

    • added the optional property metadata/tlsVersion_stddev to the response with the 200 status

      response-optional-property-added

    • added the optional property metadata/tlsVersion_sum 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 series/items/data 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