Administration

Retrieves dotCMS usage data

Changed on

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.

get/api/v1/telemetry/stats

Request

Query parameters

metricNamesstring

Comma-separated list of specific metric names to retrieve. If not specified, all metrics matching the profile will be returned.

profilestring

Profile type to use for metric collection. Options: MINIMAL (10-15 core metrics, <5s), STANDARD (~50 metrics, <15s), FULL (all 100+ metrics). Defaults to FULL for API access.

bypassCacheboolean

Bypass cache to force fresh metric computation. Use for diagnostics to see actual database query times. Defaults to false (use cache if available).

Response

i18nMessagesMapobject
permissionsstring[]

Changes

    • warning

      added the new AI enum value to the /// response property for the response status

    • warning

      added the new AI enum value to the //// response property for the response status

    • warning

      added the new AI enum value to the /// response property for the response status

    • warning

      added the new EXPERIMENTS enum value to the /// response property for the response status

    • warning

      added the new EXPERIMENTS enum value to the //// response property for the response status

    • warning

      added the new EXPERIMENTS enum value to the /// response property for the response status

    • info

      api tag Administration added

    • info

      added the new optional query request parameter bypassCache

    • info

      added the new optional query request parameter metricNames

    • info

      added the new optional query request parameter profile

    • info

      added the optional property / to the response with the status

    • info

      added the optional property / to the response with the status