---
title: "POST /reports/assets:getSummary"
method: POST
path: "/reports/assets:getSummary"
tags: ["Reports"]
---

# POST /reports/assets:getSummary

`POST /reports/assets:getSummary`

Get asset summary details for the summary request.

## Query parameters

- `api-version` string, required

## Request body

- ReportAssetSummaryRequest — A request body used to retrieve summary asset information. One and only one collection of summary identifiers must be provided: filters, metrics, or metricCategories.
  - `metricCategories` string[] — Categories to retrieve risk reporting data for.
  - `metrics` string[] — Metrics to retrieve risk reporting data for.
  - `filters` string[] — Query filters to apply to the asset summary.
  - `groupBy` string — A parameter to group the assets by (first level facet field), only used when the chosen summary identifier is filters.
  - `segmentBy` string — A parameter to segment the assets by (second level facet field), only used when the chosen summary identifier is filters.
  - `labelName` string — Currently unused.

## Response `200`

The request has succeeded.

- ReportAssetSummaryResult
  - `assetSummaries` AssetSummaryResult[] — The collection of asset summaries.
    - `displayName` string — The name of the summary response. Depending on the request time this will either be the asset filter, risk category, or risk metric.
    - `description` string — The description of the summary response. Filters don't have a description.
    - `updatedAt` string, date-time — The last time risk categories or risk metrics were captured. Set to the current time for asset filter requests, which always pull the live asset data.
    - `metricCategory` string — If the request is for a metric category, this will contain the requested unique category name.
    - `metric` string — If the request is for a metric, this will contain the requested unique metric name.
    - `filter` string — If the request is for an asset filter, this will contain the corresponding filter.
    - `labelName` string — An optional label used to filter requests results.
    - `count` integer — The count of assets matching the request parameters.
    - `link` string — The link to the corresponding asset details.
    - `children` AssetSummaryResult[] — The corresponding child entities. For metric categories this will contain metrics. For filters with groupBy and segmentBy this will contain facets.

## Other responses

- `default` — An unexpected error response.

---

[API](https://skmtc.net/azure/apis/riskiq-microsoft-easm.md) · [All operations](https://skmtc.net/azure/apis/riskiq-microsoft-easm/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/azure/riskiq-microsoft-easm/revisions/5865b52c51a3/schema)