Skip to main content
Forecast Policy Usage

Authorizations

Authorization
string
header
required

API key authentication

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.

day
Day · object
required

Marker selecting a one-day forecast window.

logRules
Log Rules · object
required

Log rules for a policy.

applicationRule
object

Rule.

rumRules
Log Rules · 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.

Required string length: 1 - 20
Pattern: ^-?[0-9]+$
Example:

"3600000"

week
Week · object

Marker selecting a one-week forecast window.

Response

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

estimatedBytes
string
required

Estimated number of bytes the draft policy would match over the requested time window.

Required string length: 1 - 20
Pattern: ^-?[0-9]+$
Example:

"13251739648"

usageBuckets
Usage Bucket · object[]

Per-bucket breakdown of matched bytes over the requested time window. Empty unless time_bucket_ms was set on the request.

Maximum array length: 10080