Query data usage

POSThttps://api.coralogix.com/mgmt/openapi/5/dataplan/data-usage/v1/query

Returns billable data usage aggregated into daily or hourly buckets. Supports filtering and grouping by labels listed by the capabilities endpoint.

Requires the following permissions:

• data-usage:Read

Authorizations

Authorizationstringheaderrequired

API key authentication

The value is a Coralogix API key. Create a personal or team API key and assign its permissions.

Request

Body

application/json

Shared query payload used by both unary and streamed data-usage methods.

oneOf
• Option 1
• Option 2
• Option 3
object
daily#object

Day-oriented query. Always returns 1-day UTC buckets.

oneOf

• Option 1
• Option 2
• Option 3

object

daily.dateRange# object

Half-open UTC calendar date interval [start, end). Both bounds are required full calendar dates.

daily.relativeRange#Daily relative range

Relative day-oriented presets resolved by the server at request time.

Possible values: [DAILY_RELATIVE_RANGE_UNSPECIFIED, DAILY_RELATIVE_RANGE_CURRENT_MONTH, DAILY_RELATIVE_RANGE_PREVIOUS_MONTH, DAILY_RELATIVE_RANGE_CURRENT_YEAR, DAILY_RELATIVE_RANGE_LAST_7_DAYS, DAILY_RELATIVE_RANGE_LAST_14_DAYS, DAILY_RELATIVE_RANGE_LAST_30_DAYS, DAILY_RELATIVE_RANGE_LAST_90_DAYS, DAILY_RELATIVE_RANGE_LAST_180_DAYS, DAILY_RELATIVE_RANGE_LAST_365_DAYS]

filters# object[]
Label predicates applied before aggregation.
Possible values: <= 16
groupBy# object
Label keys to group results by. Supported keys are listed by the capabilities endpoint.
hourly#object
Hour-oriented query. Always returns 1-hour buckets. Max window: 14 days.
oneOf
• Option 1
• Option 2
• Option 3
object
hourly.relativeRange#Hourly relative range
Relative hour-oriented presets resolved by the server at request time.
Possible values: [HOURLY_RELATIVE_RANGE_UNSPECIFIED, HOURLY_RELATIVE_RANGE_LAST_12_HOURS, HOURLY_RELATIVE_RANGE_LAST_24_HOURS, HOURLY_RELATIVE_RANGE_LAST_48_HOURS, HOURLY_RELATIVE_RANGE_LAST_7_DAYS, HOURLY_RELATIVE_RANGE_LAST_14_DAYS]
hourly.timeRange# object
Half-open timestamp interval [start, end). Both bounds are required.
limit# object
Per-bucket result-size cap. The server may reject queries whose pre-cap size still exceeds its hard limits.
measurementKindFilter#Measurement kind[]

Measurement kind filter applied before aggregation. Omit (or pass an empty list) to include all supported measurement kinds.

Possible values: [MEASUREMENT_KIND_UNSPECIFIED, MEASUREMENT_KIND_PROCESSED_DATA_SIZE, MEASUREMENT_KIND_EVALUATIONS, MEASUREMENT_KIND_PROCESSED_EVENTS, MEASUREMENT_KIND_OLLY], <= 8

Response

200application/json

Bucket-first usage results for the resolved query interval.

buckets# object[]
Bucket-first usage results. Daily queries yield one bucket per UTC calendar day; hourly queries yield one bucket per UTC hour.
Possible values: <= 1827
queryRange# object
Resolved half-open timestamp range of the query after applying absolute or relative interval semantics.