CHchecklyhq
Usage

Get usage series

Changed on

Get paginated consumption across usage terms. Group by account, usage term, pricing rule and check type.

get/v2/usage/series

Request

Query parameters

fromstring date

Inclusive UTC date. Defaults to the earliest selected usage start, or to.

tostring date

Inclusive UTC date. Defaults to today.

usageTermsIdsstring[]
accountIdsstring[]
pricingRuleKeysstring[]
limitinteger
nextIdstring

Query-bound cursor. Live reads do not freeze measurements or prices.

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

Monday weeks and calendar months; boundary buckets are clipped.

groupBystring[]
includestring[]

Headers

x-checkly-accountstring uuid

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

Response

Successful

usageTermsIdsstring[] required
interval'total' | 'day' | 'week' | 'month' required
groupBystring[] 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

    • 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
    • breaking

      removed the enum value calculations from the query request parameter include

    • breaking

      for the query request parameter include, the minItems was increased from 0 to 1

    • info

      for the query request parameter include, the type was generalized from string to array

    • info

      added the optional property // to the response with the status

    • info

      added the optional property // to the response with the status

    • info

      added subschema #1 subschema #2 subschema #3 to the ///// response property anyOf list for the response status

    • info

      removed subschema #1 subschema #2 subschema #3 from the ///// response property anyOf list for the response status