v1

latestSwagger 2.02026-07-17176789777.3 KB
groups

Get Entities.

Get entities from entity db.

post/groups

Request body

number_of_intervals_for_latest_datainteger

When retrieving latest values, how far back to look as a multiple of the downsampling interval for the metric.

filter_criteriastring

FIQL filter criteria that will be used to filter the returned data.

group_sort_attributestring

The name of the attribute that will be used to sort groups.

number_of_bucketsinteger

For grouping, how many groups to return.

entity_idsstring[]

A set of entities that the request will be scoped to.

group_countinteger

The maximum number of groups to return in the result.

group_member_sort_attributestring

The name of the attribute that will be used to sort group members.

bucket_boundaryinteger

For grouping, the boundary to snap to when grouping.

group_offsetinteger

The offset into the total set of groups to return.

interval_end_msinteger

For a time-series query, the end of the interval since the epoch in ms. Default is latest value only.

downsampling_intervalinteger

Downsampling interval to apply to query if override is desired.

availability_zone_scopestring

The scope of availability zones from which to fetch the data.

interval_start_msinteger

For a time-series query, the start of the interval since the epoch in ms. Default is latest value only.

entity_typestring required

The entity type that will be requested.

grouping_attribute_typestring

The type of an attribute being used for grouping - may be continuous or discrete.

group_member_offsetinteger

The offset into the total member set to return per group.

group_member_countinteger

The maximum number of members to return per group.

grouping_attributestring

Attribute that will be used to perform a group-by if needed.

group_member_sort_downsampling_functionstring

Downsampling function to take time series data and resolve to one value for sorting purposes.

group_member_sort_orderstring

Sort order for entities and entity groups.

query_namestring

A custom name to use for tagging the query when debugging.

group_sort_orderstring

Sort order for entities and entity groups.

group_sort_downsample_functionstring

Downsampling function to take time series data and resolve to one value for sorting purposes.

Response

Success

filtered_entity_countinteger
entity_typestring
filtered_group_countinteger
total_entity_countinteger
total_group_countinteger