---
title: "List consumption analytics facets"
method: POST
path: "/api/w/{wId}/analytics/consumption/facets"
tags: ["Private Analytics"]
---

# List consumption analytics facets

`POST /api/w/{wId}/analytics/consumption/facets`

Lists current workspace entities and historical indexed values present in the selected period for each consumption dimension. A facet is disabled when it has no indexed document in that period after applying every active filter except the facet's own dimension.

## Path parameters

- `wId` string, required

## Request body

- object
  - `period` 'cycle' | 'days'
  - `days` integer
  - `filter` object — Map of consumption dimensions to selected values.
    - `agents` string[]
    - `users` string[]
    - `api_keys` string[]
    - `groups` string[]
    - `models` string[]
    - `tools` string[]
    - `skills` string[]
    - `sources` string[]

## Response `200`

Consumption facets and their contextual availability

- object
  - `period` object, required
    - `startDate` string, date-time, required
    - `endDate` string, date-time, required
  - `facets` object, required
    - `agent` PrivateConsumptionFacet[], required
      - `value` string, required — Raw indexed value accepted by the corresponding consumption filter.
      - `label` string, required — Human-readable label, falling back to the raw value when its resource was deleted.
      - `pictureUrl` string, nullable, required
      - `icon` string, nullable — Design-system icon name for tool and skill facets when known.
      - `documentCount` integer, required — Number of matching indexed documents after applying the selected period and every other facet.
      - `disabled` boolean, required — Whether selecting this value would produce no matching indexed document.
      - `scope` 'global' | 'visible' | 'hidden' — Current agent scope, when the agent still has accessible configuration metadata.
      - `maker` string — Model maker, for known model facets.
      - `tier` 'cost_efficient' | 'balanced' | 'premium' — Default reasoning-effort tier, for known model facets.
    - `user` PrivateConsumptionFacet[], required
      - `value` string, required — Raw indexed value accepted by the corresponding consumption filter.
      - `label` string, required — Human-readable label, falling back to the raw value when its resource was deleted.
      - `pictureUrl` string, nullable, required
      - `icon` string, nullable — Design-system icon name for tool and skill facets when known.
      - `documentCount` integer, required — Number of matching indexed documents after applying the selected period and every other facet.
      - `disabled` boolean, required — Whether selecting this value would produce no matching indexed document.
      - `scope` 'global' | 'visible' | 'hidden' — Current agent scope, when the agent still has accessible configuration metadata.
      - `maker` string — Model maker, for known model facets.
      - `tier` 'cost_efficient' | 'balanced' | 'premium' — Default reasoning-effort tier, for known model facets.
    - `api_key` PrivateConsumptionFacet[], required
      - `value` string, required — Raw indexed value accepted by the corresponding consumption filter.
      - `label` string, required — Human-readable label, falling back to the raw value when its resource was deleted.
      - `pictureUrl` string, nullable, required
      - `icon` string, nullable — Design-system icon name for tool and skill facets when known.
      - `documentCount` integer, required — Number of matching indexed documents after applying the selected period and every other facet.
      - `disabled` boolean, required — Whether selecting this value would produce no matching indexed document.
      - `scope` 'global' | 'visible' | 'hidden' — Current agent scope, when the agent still has accessible configuration metadata.
      - `maker` string — Model maker, for known model facets.
      - `tier` 'cost_efficient' | 'balanced' | 'premium' — Default reasoning-effort tier, for known model facets.
    - `group` PrivateConsumptionFacet[], required
      - `value` string, required — Raw indexed value accepted by the corresponding consumption filter.
      - `label` string, required — Human-readable label, falling back to the raw value when its resource was deleted.
      - `pictureUrl` string, nullable, required
      - `icon` string, nullable — Design-system icon name for tool and skill facets when known.
      - `documentCount` integer, required — Number of matching indexed documents after applying the selected period and every other facet.
      - `disabled` boolean, required — Whether selecting this value would produce no matching indexed document.
      - `scope` 'global' | 'visible' | 'hidden' — Current agent scope, when the agent still has accessible configuration metadata.
      - `maker` string — Model maker, for known model facets.
      - `tier` 'cost_efficient' | 'balanced' | 'premium' — Default reasoning-effort tier, for known model facets.
    - `model` PrivateConsumptionFacet[], required
      - `value` string, required — Raw indexed value accepted by the corresponding consumption filter.
      - `label` string, required — Human-readable label, falling back to the raw value when its resource was deleted.
      - `pictureUrl` string, nullable, required
      - `icon` string, nullable — Design-system icon name for tool and skill facets when known.
      - `documentCount` integer, required — Number of matching indexed documents after applying the selected period and every other facet.
      - `disabled` boolean, required — Whether selecting this value would produce no matching indexed document.
      - `scope` 'global' | 'visible' | 'hidden' — Current agent scope, when the agent still has accessible configuration metadata.
      - `maker` string — Model maker, for known model facets.
      - `tier` 'cost_efficient' | 'balanced' | 'premium' — Default reasoning-effort tier, for known model facets.
    - `tool` PrivateConsumptionFacet[], required
      - `value` string, required — Raw indexed value accepted by the corresponding consumption filter.
      - `label` string, required — Human-readable label, falling back to the raw value when its resource was deleted.
      - `pictureUrl` string, nullable, required
      - `icon` string, nullable — Design-system icon name for tool and skill facets when known.
      - `documentCount` integer, required — Number of matching indexed documents after applying the selected period and every other facet.
      - `disabled` boolean, required — Whether selecting this value would produce no matching indexed document.
      - `scope` 'global' | 'visible' | 'hidden' — Current agent scope, when the agent still has accessible configuration metadata.
      - `maker` string — Model maker, for known model facets.
      - `tier` 'cost_efficient' | 'balanced' | 'premium' — Default reasoning-effort tier, for known model facets.
    - `skill` PrivateConsumptionFacet[], required
      - `value` string, required — Raw indexed value accepted by the corresponding consumption filter.
      - `label` string, required — Human-readable label, falling back to the raw value when its resource was deleted.
      - `pictureUrl` string, nullable, required
      - `icon` string, nullable — Design-system icon name for tool and skill facets when known.
      - `documentCount` integer, required — Number of matching indexed documents after applying the selected period and every other facet.
      - `disabled` boolean, required — Whether selecting this value would produce no matching indexed document.
      - `scope` 'global' | 'visible' | 'hidden' — Current agent scope, when the agent still has accessible configuration metadata.
      - `maker` string — Model maker, for known model facets.
      - `tier` 'cost_efficient' | 'balanced' | 'premium' — Default reasoning-effort tier, for known model facets.
    - `source` PrivateConsumptionFacet[], required
      - `value` string, required — Raw indexed value accepted by the corresponding consumption filter.
      - `label` string, required — Human-readable label, falling back to the raw value when its resource was deleted.
      - `pictureUrl` string, nullable, required
      - `icon` string, nullable — Design-system icon name for tool and skill facets when known.
      - `documentCount` integer, required — Number of matching indexed documents after applying the selected period and every other facet.
      - `disabled` boolean, required — Whether selecting this value would produce no matching indexed document.
      - `scope` 'global' | 'visible' | 'hidden' — Current agent scope, when the agent still has accessible configuration metadata.
      - `maker` string — Model maker, for known model facets.
      - `tier` 'cost_efficient' | 'balanced' | 'premium' — Default reasoning-effort tier, for known model facets.

## Other responses

- `400` — Invalid request body
- `403` — Manager role required
- `500` — Failed to retrieve consumption facets

---

[API](https://skmtc.net/dust-tt/apis/dust-api-documentation.md) · [All operations](https://skmtc.net/dust-tt/apis/dust-api-documentation/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/dust-tt/dust-api-documentation/revisions/24a308e0da1c/schema)