Collect Performance Metrics

YouTrack provides performance metrics that help you monitor the current load and health of your site.

You can view metrics in the user interface when you need a current snapshot, or collect telemetry data programmatically with the REST API.

Collect Metrics with the REST API

Use the REST API when you want a monitoring tool or script to poll YouTrack and save metric values over time. The telemetry endpoint returns JSON and only includes the fields you request.

The resource path is /api/admin/telemetry. The list of returned attributes depends on whether you use YouTrack Server or YouTrack Cloud. For attributes that are not supported in your edition, YouTrack returns null.

To collect performance metrics with the REST API:

Generate a permanent token for a user account that has the Low-level Admin Read permission.
Choose the telemetry fields that you want to collect. Common fields for performance monitoring include databaseSize, fullDatabaseSize, textIndexSize, requestsPerSecond, transactionsPerSecond, pendingAsyncJobs, onlineUsers(users), uptime, and startedTime.
Send a GET request to <youtrack-base-url>/api/admin/telemetry with the selected fields in the fields query parameter and the token in the Authorization header.
Configure your monitoring tool to repeat the request on the schedule that matches your monitoring needs.

Replace example with the subdomain for your YouTrack site. For Cloud sites that use a different base URL, use the full URL that opens your YouTrack site.

curl -X GET \
  'https://example.youtrack.cloud/api/admin/telemetry?fields=databaseSize,uptime,startedTime,textIndexSize,onlineUsers(users)' \
  -H 'Authorization: Bearer <permanent-token>' \
  -H 'Accept: application/json'

A successful request returns a JSON object with the requested fields.

{
  "startedTime": 1610613083628,
  "databaseSize": "5.0 MB",
  "textIndexSize": "0.1 MB",
  "uptime": "644 hours, 19 minutes, 10 seconds and 121 milliseconds",
  "onlineUsers": {
    "users": 12,
    "$type": "OnlineUsers"
  },
  "$type": "Telemetry"
}

For the complete list of telemetry fields and their data types, see the REST API reference for telemetry data.

Collect Metrics from the User Interface

Use the Server Metrics page when you need to review the current values manually, for example, while troubleshooting a slow site or collecting information for a support request.

To view performance metrics in YouTrack:

Open the Administration menu and select Server Settings > Global Settings.
Scroll to the bottom of the Server Configuration tab.
In the Server Metrics section, click View server metrics.
Review the values on the Server Metrics page and record the metrics that are relevant to your investigation.

For detailed descriptions of the metrics shown on this page, see Server Metrics.

23 June 2026