---
title: "Retrieves dotCMS usage data"
method: GET
path: "/api/v1/telemetry/stats"
tags: ["Administration"]
---

# Retrieves dotCMS usage data

`GET /api/v1/telemetry/stats`

Collects telemetry metrics based on the specified profile. Defaults to FULL profile to return all available metrics. Use MINIMAL profile for dashboard (faster, ~10 metrics) or FULL for complete data (~100+ metrics). Set bypassCache=true to force fresh metric computation bypassing cache.

## Query parameters

- `metricNames` string
- `profile` string
- `bypassCache` boolean

## Response `200`

- ResponseEntityMetricsSnapshotView
  - `errors` ErrorEntity[]
    - `errorCode` string
    - `message` string
    - `fieldName` string
  - `entity` MetricsSnapshot
    - `stats` MetricValue[]
      - `name` string
      - `description` string
      - `category` 'DIFFERENTIATING_FEATURES' | 'PAID_FEATURES' | 'PLATFORM_SPECIFIC_CUSTOMIZATION' | 'SOPHISTICATED_CONTENT_ARCHITECTURE' | 'POSITIVE_USER_EXPERIENCE' | 'PLATFORM_SPECIFIC_DEVELOPMENT' | 'RECENT_ACTIVITY' | 'HISTORY_LEGACY_DEPRECATED_FEATURES'
      - `feature` 'CONTENTLETS' | 'LANGUAGES' | 'CONTENT_TYPES' | 'SITES' | 'URL_MAPS' | 'WORKFLOW' | 'USERS' | 'SITE_SEARCH' | 'IMAGE_API' | 'LAYOUT' | 'CONTENT_TYPE_FIELDS' | 'AI' | 'EXPERIMENTS'
      - `value` object
    - `errors` MetricCalculationError[]
      - `name` string
      - `description` string
      - `category` 'DIFFERENTIATING_FEATURES' | 'PAID_FEATURES' | 'PLATFORM_SPECIFIC_CUSTOMIZATION' | 'SOPHISTICATED_CONTENT_ARCHITECTURE' | 'POSITIVE_USER_EXPERIENCE' | 'PLATFORM_SPECIFIC_DEVELOPMENT' | 'RECENT_ACTIVITY' | 'HISTORY_LEGACY_DEPRECATED_FEATURES'
      - `feature` 'CONTENTLETS' | 'LANGUAGES' | 'CONTENT_TYPES' | 'SITES' | 'URL_MAPS' | 'WORKFLOW' | 'USERS' | 'SITE_SEARCH' | 'IMAGE_API' | 'LAYOUT' | 'CONTENT_TYPE_FIELDS' | 'AI' | 'EXPERIMENTS'
      - `error` string
      - `type` Metric
        - `name` string
        - `description` string
        - `category` 'DIFFERENTIATING_FEATURES' | 'PAID_FEATURES' | 'PLATFORM_SPECIFIC_CUSTOMIZATION' | 'SOPHISTICATED_CONTENT_ARCHITECTURE' | 'POSITIVE_USER_EXPERIENCE' | 'PLATFORM_SPECIFIC_DEVELOPMENT' | 'RECENT_ACTIVITY' | 'HISTORY_LEGACY_DEPRECATED_FEATURES'
        - `feature` 'CONTENTLETS' | 'LANGUAGES' | 'CONTENT_TYPES' | 'SITES' | 'URL_MAPS' | 'WORKFLOW' | 'USERS' | 'SITE_SEARCH' | 'IMAGE_API' | 'LAYOUT' | 'CONTENT_TYPE_FIELDS' | 'AI' | 'EXPERIMENTS'
    - `timings` MetricTiming[]
      - `metricName` string
      - `durationMs` integer
      - `cacheHit` boolean
      - `computationMs` integer
      - `timedOut` boolean
      - `slow` boolean
    - `notNumericMetricValues` MetricValue[]
      - `name` string
      - `description` string
      - `category` 'DIFFERENTIATING_FEATURES' | 'PAID_FEATURES' | 'PLATFORM_SPECIFIC_CUSTOMIZATION' | 'SOPHISTICATED_CONTENT_ARCHITECTURE' | 'POSITIVE_USER_EXPERIENCE' | 'PLATFORM_SPECIFIC_DEVELOPMENT' | 'RECENT_ACTIVITY' | 'HISTORY_LEGACY_DEPRECATED_FEATURES'
      - `feature` 'CONTENTLETS' | 'LANGUAGES' | 'CONTENT_TYPES' | 'SITES' | 'URL_MAPS' | 'WORKFLOW' | 'USERS' | 'SITE_SEARCH' | 'IMAGE_API' | 'LAYOUT' | 'CONTENT_TYPE_FIELDS' | 'AI' | 'EXPERIMENTS'
      - `value` object
  - `messages` MessageEntity[]
    - `message` string
  - `i18nMessagesMap` object
  - `permissions` string[]
  - `pagination` Pagination
    - `currentPage` integer
    - `perPage` integer
    - `totalEntries` integer

---

[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)
