RelativeTimeRangeDto

object

A duration representing a relative-to-now span of time. Generally the start time is floored to the requested granularity. Eg 7d from now, with 1day granularity initiated at 2024-01-08T17:11:00+05:00 will query for the time range from 2024-01-01T00:00:00+05:00 to 2024-01-08T17:11:00+05:00. The exact start and end timestamps are returned in the result query in the meta.start and meta.end fields. If the granularity for the previous query was 1hour, it would query a time range from 2024-01-01T17:00:00+05:00 to 2024-01-08T17:11:00+05:00.

tzstring

Default:Etc/UTC

typestringrequired

Allowed values:relative

time_rangestringrequired

Allowed values:15m1h6h12h24h7d30dcurrent_weekcurrent_monthprevious_weekprevious_month

Default:1h

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

ApiFilter

object
* Additional properties are NOT allowed.
fieldstringrequired

The dimension to filter.

Allowed values:api

operatorstringrequired

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

valuearray[string]required

The UUIDs of the API product versions 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

ApplicationFilter

object
* Additional properties are NOT allowed.
fieldstringrequired

The dimension to filter. If no application filter is provided the API will implicitly filter on the applications owned by the developer making the query request.

Allowed values:application

operatorstringrequired

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

valuearray[string]required

The UUIDs of the dev portal applications 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

StatusCodeFilter

object
* Additional properties are NOT allowed.
fieldstringrequired

The dimension to filter.

Allowed values:status_code

operatorstringrequired

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

valuearray[integer]required

Only include requests with specific status codes in the results.

>= 100<= 999

Example