---
title: "List Summaries Endpoint"
method: GET
path: "/api/v2/summaries"
tags: ["APPS_V2"]
---

# List Summaries Endpoint

`GET /api/v2/summaries`

List summaries visible on the requesting tenant's platform.

## Headers

- `x-tenant` string, required
- `x-user-group-id` string, nullable
- `x-timezone` string, nullable

## Response `200`

Successful Response

- SummaryDescriptor[]
  - `name` string, required
  - `label` string, required
  - `platform` string, required
  - `dataset` string, required
  - `parts` string[], required
  - `filters` FilterDescriptor[], required
    - `key` string, required
    - `label` string, required
    - `listable` boolean, required
    - `options` OptionDescriptor[], nullable
      - `value` string, required
      - `label` string, nullable
  - `metrics` MetricDescriptor[], required
    - `key` string, required
    - `label` string, required
    - `unit` string, nullable
    - `info` string, nullable
    - `order` integer, required
    - `tone` string, nullable
    - `compact` boolean
  - `related` RelatedDescriptor, required — Wire form of `apps.catalog.relations.RelatedNames` — the symmetrised page-affinity edges of one dataset/chart/summary, split by kind. This module owns no catalog lookups (see the module docstring's import rules), so nothing here builds a `RelatedDescriptor` from a `RelatedNames` — that projection lives in `apps.api.serializers`, the layer that already resolves `apps.catalog.RELATIONS`.
    - `datasets` string[], required
    - `charts` string[], required
    - `summaries` string[], required

## Other responses

- `403` — Not supported for public user
- `422` — Validation Error

---

[API](https://skmtc.net/myaltimate/apis/fastapi.md) · [All operations](https://skmtc.net/myaltimate/apis/fastapi/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/myaltimate/fastapi/revisions/33e87d9898ad/schema)