Forecast Policy Usage

POSThttps://api.coralogix.com/mgmt/openapi/5/dataplans/policies/v1/all/forecast-usage

Forecasts the usage in bytes that a draft TCO policy would match over the requested time window, given its application/subsystem rules and log or span filters. Use this before saving a new or modified policy to see the impact on your quota.

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

Request to forecast the usage in bytes of a draft TCO policy, based on the bytes matched by its filter rules over a given time window.

oneOf

• Option 1
• Option 2
• Option 3

object

oneOf

• Option 1
• Option 2
• Option 3

object

applicationRule# object

Rule.

day#object

Marker selecting a one-day forecast window.

logRules# object

Log rules for a policy.

spanRules# object

Span rules.

subsystemRule# object

Rule.

timeBucketMs#string

Optional bucket size, in milliseconds, used to split the forecast into time buckets. When set, the response includes a per-bucket breakdown in usage_buckets; when omitted, only the total estimated bytes are returned.

Possible values: non-empty and <= 20 characters, Value must match regular expression ^-?[0-9]+$

Example: 3600000

week#object

Marker selecting a one-week forecast window.

Response

200400401500application/json

Forecasted usage in bytes for a draft TCO policy, based on bytes matched over a given time window.

estimatedBytes#stringrequired
Estimated number of bytes the draft policy would match over the requested time window.
Possible values: non-empty and <= 20 characters, Value must match regular expression ^-?[0-9]+$
Example: 13251739648
usageBuckets# object[]
Per-bucket breakdown of matched bytes over the requested time window. Empty unless time_bucket_ms was set on the request.
Possible values: <= 10080