---
title: "Get Entities."
method: POST
path: "/groups"
tags: ["groups"]
---

# Get Entities.

`POST /groups`

Get entities from entity db.

## Request body

- GroupsGetEntitiesRequest — Get Entities Request.
  - `number_of_intervals_for_latest_data` integer — When retrieving latest values, how far back to look as a multiple of the downsampling interval for the metric.
  - `filter_criteria` string — FIQL filter criteria that will be used to filter the returned data.
  - `group_sort_attribute` string — The name of the attribute that will be used to sort groups.
  - `group_attributes` GroupsRequestedAttribute[]
    - `attribute` string, required
    - `operation` string — Downsampling function to take time series data and resolve to one value for aggregation purposes.
    - `ancestor_entity_type` string
  - `number_of_buckets` integer — For grouping, how many groups to return.
  - `entity_ids` string[] — A set of entities that the request will be scoped to.
  - `group_count` integer — The maximum number of groups to return in the result.
  - `group_member_attributes` GroupsRequestedAttribute[]
    - `attribute` string, required
    - `operation` string — Downsampling function to take time series data and resolve to one value for aggregation purposes.
    - `ancestor_entity_type` string
  - `group_member_sort_attribute` string — The name of the attribute that will be used to sort group members.
  - `bucket_boundary` integer — For grouping, the boundary to snap to when grouping.
  - `group_offset` integer — The offset into the total set of groups to return.
  - `interval_end_ms` integer — For a time-series query, the end of the interval since the epoch in ms. Default is latest value only.
  - `downsampling_interval` integer — Downsampling interval to apply to query if override is desired.
  - `availability_zone_scope` string — The scope of availability zones from which to fetch the data.
  - `interval_start_ms` integer — For a time-series query, the start of the interval since the epoch in ms. Default is latest value only.
  - `entity_type` string, required — The entity type that will be requested.
  - `grouping_attribute_type` string — The type of an attribute being used for grouping - may be continuous or discrete.
  - `group_member_offset` integer — The offset into the total member set to return per group.
  - `group_member_count` integer — The maximum number of members to return per group.
  - `grouping_attribute` string — Attribute that will be used to perform a group-by if needed.
  - `group_member_sort_downsampling_function` string — Downsampling function to take time series data and resolve to one value for sorting purposes.
  - `group_member_sort_order` string — Sort order for entities and entity groups.
  - `query_name` string — A custom name to use for tagging the query when debugging.
  - `group_sort_order` string — Sort order for entities and entity groups.
  - `group_sort_downsample_function` string — Downsampling function to take time series data and resolve to one value for sorting purposes.

## Response `200`

Success

- GroupsGetEntitiesResponse — Get Entities Response.
  - `filtered_entity_count` integer
  - `group_results` GroupsGroupResult[]
    - `entity_results` GroupsEntity[]
      - `entity_id` string
      - `data` GroupsFieldData[]
        - `buckets` GroupsBucketSummaryMap — Group Bucket Summary Map.
        - `values` GroupsTimevaluePair[]
          - `values` string[]
          - `time` integer
        - `name` string
    - `group_by_column_value` string
    - `total_entity_count` integer
    - `group_summaries` GroupsGroupSummaryMap — Group Summary Info Map.
  - `entity_type` string
  - `filtered_group_count` integer
  - `total_entity_count` integer
  - `total_group_count` integer

## Other responses

- `default` — Internal Error

---

[API](https://skmtc.net/nutanix/apis/nutanix-intentful-api.md) · [All operations](https://skmtc.net/nutanix/apis/nutanix-intentful-api/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/nutanix/nutanix-intentful-api/versions/40395083ab31/schema)