GET
/
v2
/
datausage
const fetch = require('node-fetch');

let url = 'https://api.coralogix.com/mgmt/openapi/v2/datausage?dateRange.fromDate=SOME_STRING_VALUE&dateRange.toDate=SOME_STRING_VALUE&resolution=SOME_STRING_VALUE&aggregate=SOME_ARRAY_VALUE';

let options = {method: 'GET', headers: {Authorization: 'Bearer <API_KEY>'}};

fetch(url, options)
  .then(res => res.json())
  .then(json => console.log(json))
  .catch(err => console.error('error:' + err));
{
  "result": {
    "entries": [
      {
        "timestamp": "2023-11-07T05:31:56Z",
        "sizeGb": 123,
        "units": 123,
        "dimensions": [
          {
            "pillar": "PILLAR_UNSPECIFIED",
            "genericDimension": {
              "key": "key",
              "value": "value"
            },
            "tier": "TCO_TIER_UNSPECIFIED",
            "severity": "SEVERITY_UNSPECIFIED",
            "priority": "PRIORITY_UNSPECIFIED"
          }
        ]
      }
    ]
  },
  "error": {
    "code": 123,
    "message": "<string>",
    "details": [
      {
        "@type": "<string>"
      }
    ]
  }
}

Authorizations

Authorization
string
header
required

API key authentication

Query Parameters

dateRange.fromDate
string
dateRange.toDate
string
resolution
string

Aggregation resolution. Minimum supported value is 1h

Do note that to avoid overloading the service we enforce resolution limits that depend on the server configuration. This is configured by the server. This means that, for instance, requests with 1 hour resolution for an interval of 30 days will be rejected but accepted for 1 day interval.

Resolution must be between 1 hour and date_range interval

aggregate
enum<string>[]

List of aggregate parameters. i.e. if AggregateBy is [AGGREGATE_BY_PILLAR, AGGREGATE_BY_PRIORITY], then the response will stream data aggregated by pillar and priority.

Response

200
application/json

A successful response.(streaming responses)

The response is of type object.

GET
/
v2
/
datausage
const fetch = require('node-fetch');

let url = 'https://api.coralogix.com/mgmt/openapi/v2/datausage?dateRange.fromDate=SOME_STRING_VALUE&dateRange.toDate=SOME_STRING_VALUE&resolution=SOME_STRING_VALUE&aggregate=SOME_ARRAY_VALUE';

let options = {method: 'GET', headers: {Authorization: 'Bearer <API_KEY>'}};

fetch(url, options)
  .then(res => res.json())
  .then(json => console.log(json))
  .catch(err => console.error('error:' + err));
{
  "result": {
    "entries": [
      {
        "timestamp": "2023-11-07T05:31:56Z",
        "sizeGb": 123,
        "units": 123,
        "dimensions": [
          {
            "pillar": "PILLAR_UNSPECIFIED",
            "genericDimension": {
              "key": "key",
              "value": "value"
            },
            "tier": "TCO_TIER_UNSPECIFIED",
            "severity": "SEVERITY_UNSPECIFIED",
            "priority": "PRIORITY_UNSPECIFIED"
          }
        ]
      }
    ]
  },
  "error": {
    "code": 123,
    "message": "<string>",
    "details": [
      {
        "@type": "<string>"
      }
    ]
  }
}

Authorizations

Authorization
string
header
required

API key authentication

Query Parameters

dateRange.fromDate
string
dateRange.toDate
string
resolution
string

Aggregation resolution. Minimum supported value is 1h

Do note that to avoid overloading the service we enforce resolution limits that depend on the server configuration. This is configured by the server. This means that, for instance, requests with 1 hour resolution for an interval of 30 days will be rejected but accepted for 1 day interval.

Resolution must be between 1 hour and date_range interval

aggregate
enum<string>[]

List of aggregate parameters. i.e. if AggregateBy is [AGGREGATE_BY_PILLAR, AGGREGATE_BY_PRIORITY], then the response will stream data aggregated by pillar and priority.

Response

200
application/json

A successful response.(streaming responses)

The response is of type object.