TimeRange

The period of time to return data. Relative time ranges are relative to the current moment. Absolute time ranges specify an unchanging period of time. If not specified, a default relative timeframe of last 24 hours will be chosen.

Default:{"type":"RELATIVE","time_period":"24H"}

One Of
typestringrequired

Allowed values:RELATIVE

time_periodstringrequired

Query data from the specified period relative to now.

Allowed values:15M1H6H12H24H7D30DCURRENT_WEEKCURRENT_MONTHPREVIOUS_WEEKPREVIOUS_MONTH

Example

RelativeTimeRange

object
typestringrequired

Allowed values:RELATIVE

time_periodstringrequired

Query data from the specified period relative to now.

Allowed values:15M1H6H12H24H7D30DCURRENT_WEEKCURRENT_MONTHPREVIOUS_WEEKPREVIOUS_MONTH

Example

AbsoluteTimeRange

object
typestringrequired

Allowed values:ABSOLUTE

startstring(date)required

An ISO-8601 date value specifying the lower bound of the time range, inclusive.

Example:2022-11-04

endstring(date)required

An ISO-8601 date value specifying the upper bound of the time range, inclusive.

Example:2022-11-04

Example

FilterType

string

The type of filter to apply. IN filters will limit results to only the specified values, while NOT_IN filters will exclude the specified values.

Allowed values:INNOT_IN

ApiProductFilter

object
dimensionstringrequired

The dimension to filter.

Allowed values:API_PRODUCT

typestringrequired

The type of filter to apply. IN filters will limit results to only the specified values, while NOT_IN filters will exclude the specified values.

Allowed values:INNOT_IN

valuesarray[string]required

The UUIDs of the API products to include in the results.

Match pattern:^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$

Example