---
title: "Get usage dashboard summary"
method: GET
path: "/api/v1/usage/summary"
tags: ["Usage"]
---

# Get usage dashboard summary

`GET /api/v1/usage/summary`

Retrieves key business metrics optimized for dashboard display including content, sites, users, and system metrics. Supports optional profile parameter (MINIMAL, STANDARD, FULL) to override the default metric collection profile.

## Query parameters

- `profile` 'MINIMAL' | 'STANDARD' | 'FULL'

## Response `200`

Dashboard summary retrieved successfully

- ResponseEntityUsageSummaryView
  - `errors` ErrorEntity[]
    - `errorCode` string
    - `message` string
    - `fieldName` string
  - `entity` UsageSummary
    - `metrics` object
    - `lastUpdated` string, date-time
  - `messages` MessageEntity[]
    - `message` string
  - `i18nMessagesMap` object
  - `permissions` string[]
  - `pagination` Pagination
    - `currentPage` integer
    - `perPage` integer
    - `totalEntries` integer

## Other responses

- `400` — Invalid profile parameter
- `401` — Unauthorized
- `403` — Forbidden
- `500` — Internal Server Error

---

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