Data Usage Query Service

Get data usage capabilities

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
get/dataplan/data-usage/v1/capabilities

Request

  • Base URL: https://api.eu1.coralogix.com/mgmt/openapi/5
  • URL: https://api.eu1.coralogix.com/mgmt/openapi/5/dataplan/data-usage/v1/capabilities
  • Auth: API key in header Authorization

Response

maxFilterValuesinteger

Maximum number of values accepted by one label filter.

maxFiltersinteger

Maximum number of label filters accepted in one query.

maxGroupByLabelsinteger

Maximum number of label keys accepted in a groupBy request.

maxUsageEntriesPerMessageinteger

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

Example response

{
  "supportedLabels": [
    {
      "key": "feature_id",
      "knownValues": [
        {
          "value": "logs_ingestion"
        }
      ]
    }
  ]
}

Changes

No recorded changes to this operation across all 1 revision of this API.