Skip to main content
Theme
Home

Get data usage capabilities

GEThttps://api.coralogix.com/mgmt/openapi/5/dataplan/data-usage/v1/capabilities

Authorizations

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

Returns the labels, measurement kinds, units, and per-request limits supported by the public data-usage API in v1, so clients can validate queries before submitting them.

Requires the following permissions:

  • data-usage:Read

Response

application/json

Capabilities of the public data-usage query surface in v1.

    maxFilterValues#int64

    Maximum number of values accepted by one label filter.

    Possible values: >= 0 and <= 1024

    maxFilters#int64

    Maximum number of label filters accepted in one query.

    Possible values: >= 0 and <= 16

    maxGroupByLabels#int64

    Maximum number of label keys accepted in a groupBy request.

    Possible values: >= 0 and <= 16

    maxUsageEntriesPerMessage#int64

    Maximum number of usage entries the server may include in a single response. 0 means no fixed entry limit is advertised.

    Possible values: >= 0 and <= 1000000

    Supported labels for the public API surface, with descriptions, cardinality hints, and any stable known values.

    Possible values: <= 256

    Supported measurement kinds and raw units returned by UsageEntry.

    Possible values: <= 32