CHchecklyhq
Usage

Get paginated usage data grouped over time.

Changed on

Deprecated. Use GET /v2/usage/series for usage across terms and pricing rules.

get/v1/usage/series

Request

Query parameters

tostring date

Date used to resolve usage terms. Defaults to today.

fromstring date

Start date, inclusive. Defaults to the resolved usage start date.

accountIdsstring[] nullable

Account IDs included in the resolved usage terms. Repeat or comma-separate values.

checkTypesstring[] nullable

Check types to include. Repeat or comma-separate values.

interval'total' | 'day' | 'week' | 'month'

Aggregation interval for response rows.

groupBy'account' | 'checkType' | 'account,checkType'

Dimensions to group response rows by.

limitinteger

Maximum number of rows to return.

nextIdstring

Opaque cursor returned by the previous page.

Headers

x-checkly-accountstring uuid

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

Response

Successful

usageTermsIdstring uuid nullable required
lengthinteger required
nextIdstring nullable required

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

  • 4698655f7ecdRevision changes
    • info

      endpoint deprecated