---
title: "View for listing entitlement token metrics, across an account."
method: GET
path: "/metrics/entitlements/{owner}/"
tags: ["metrics"]
---

# View for listing entitlement token metrics, across an account.

`GET /metrics/entitlements/{owner}/`

View for listing entitlement token metrics, across an account.

## Query parameters

- `page` integer
- `page_size` integer
- `finish` string
- `start` string
- `tokens` string

## Response `200`

Retrieved the metrics for entitlements.

- EntitlementUsageMetrics
  - `tokens` CommonMetrics, required
    - `active` integer — Number of packages with at least 1 download
    - `bandwidth` CommonBandwidthMetrics, required
      - `average` CommonBandwidthMetricsValue, required — Average bandwidth usage in the specified period, e.g. a day
        - `display` string, required — Bandwidth usage value
        - `units` string — Unit of measurement e.g. bytes
        - `value` integer, required — Human readable version of display value
      - `highest` CommonBandwidthMetricsValue, required — Average bandwidth usage in the specified period, e.g. a day
        - `display` string, required — Bandwidth usage value
        - `units` string — Unit of measurement e.g. bytes
        - `value` integer, required — Human readable version of display value
      - `lowest` CommonBandwidthMetricsValue, required — Average bandwidth usage in the specified period, e.g. a day
        - `display` string, required — Bandwidth usage value
        - `units` string — Unit of measurement e.g. bytes
        - `value` integer, required — Human readable version of display value
      - `total` CommonBandwidthMetricsValue, required — Average bandwidth usage in the specified period, e.g. a day
        - `display` string, required — Bandwidth usage value
        - `units` string — Unit of measurement e.g. bytes
        - `value` integer, required — Human readable version of display value
    - `downloads` CommonDownloadsMetrics, required
      - `average` CommonDownloadsMetricsValue, required
        - `value` integer, required
      - `highest` CommonDownloadsMetricsValue, required
        - `value` integer, required
      - `lowest` CommonDownloadsMetricsValue, required
        - `value` integer, required
      - `total` CommonDownloadsMetricsValue, required
        - `value` integer, required
    - `inactive` integer — Packages with zero downloads
    - `total` integer — Total number of packages in repo

## Other responses

- `400` — Request could not be processed (see detail).
- `422` — Missing or invalid parameters (see detail).

---

[API](https://skmtc.dev/cloudsmith/apis/cloudsmith-api-v1.md) · [All operations](https://skmtc.dev/cloudsmith/apis/cloudsmith-api-v1/llms.txt) · [OpenAPI document](https://skmtc-service-production.skmtc.workers.dev/v1/apis/cloudsmith/cloudsmith-api-v1/revisions/4d7879df9b2f/schema)