Skip to content
You're viewing documentation for v2026.11.11-beta. It may be out of date.Go to latest
TimescaleDB Enterprise
Esc
↑↓navigate↵open⌘Jpreview

Get service metrics windows

GET/api/v1/database-services/{id}/metrics
Authorization
tse_sessionAPI key · cookierequired
Path parameters
idstringrequired
Query parameters
startstring
endstring
bucketSecondsinteger<int64>
default: 60
Responses
200

OK

alertsAlertSpan[]required
Show properties
Array of AlertSpan
alertstringrequired
endstringrequired
serverstring

Empty when the alert is about the whole service

severitystring
startstringrequired
computeComputeWindow[]required
Show properties
Array of ComputeWindow
dataComputePoint[]required
Show properties
Array of ComputePoint
cpuPercentnumber<double>
memoryPercentnumber<double>
memoryTotalBytesnumber<double>
memoryUsedBytesnumber<double>
timestringrequired
ordinalinteger<int64>required
rolestringrequired
Allowed:primaryreplica
serverstringrequired
connectionsConnectionsWindow[]required
Show properties
Array of ConnectionsWindow
dataConnectionsPoint[]required
Show properties
Array of ConnectionsPoint
activenumber<double>
maxnumber<double>
timestringrequired
totalnumber<double>
ordinalinteger<int64>required
rolestringrequired
Allowed:primaryreplica
serverstringrequired
diskPerformanceDiskWindow[]required
Show properties
Array of DiskWindow
dataDiskPoint[]required
Show properties
Array of DiskPoint
readBytesPerSecnumber<double>
readIOPSnumber<double>
timestringrequired
writeBytesPerSecnumber<double>
writeIOPSnumber<double>
ordinalinteger<int64>required
rolestringrequired
Allowed:primaryreplica
serverstringrequired
queriesPerSecondQpsWindow[]required
Show properties
Array of QpsWindow
dataQpsPoint[]required
Show properties
Array of QpsPoint
timestringrequired
tpsnumber<double>
ordinalinteger<int64>required
rolestringrequired
Allowed:primaryreplica
serverstringrequired
replicationReplicationWindow[]required
Show properties
Array of ReplicationWindow
dataReplicationPoint[]required
Show properties
Array of ReplicationPoint
lagSecondsnumber<double>

The replication lag of the node in seconds

timestringrequired
ordinalinteger<int64>required
rolestringrequired
Allowed:primaryreplica
serverstringrequired
storageStorageWindow[]required
Show properties
Array of StorageWindow
dataStoragePoint[]required
Show properties
Array of StoragePoint
databaseSizeBytesnumber<double>
diskTotalBytesnumber<double>
diskUsedBytesnumber<double>
timestringrequired
ordinalinteger<int64>required
rolestringrequired
Allowed:primaryreplica
serverstringrequired
default

Error

codestring

Stable code of the refusal, when the route has codes

detailsstring[]

Additional detail, e.g. per-field validation failures

errorstringrequired

Human-readable error message

Request
curl -X GET 'https://console.example.com/api/v1/database-services/string/metrics' \
  -H 'Cookie: tse_session=YOUR_API_KEY' \
  -H 'Accept: application/json'
Response
{
  "alerts": [
    {
      "alert": "string",
      "end": "string",
      "server": "string",
      "severity": "string",
      "start": "string"
    }
  ],
  "compute": [
    {
      "data": [
        {
          "cpuPercent": 0.1,
          "memoryPercent": 0.1,
          "memoryTotalBytes": 0.1,
          "memoryUsedBytes": 0.1,
          "time": "string"
        }
      ],
      "ordinal": 0,
      "role": "primary",
      "server": "string"
    }
  ],
  "connections": [
    {
      "data": [
        {
          "active": 0.1,
          "max": 0.1,
          "time": "string",
          "total": 0.1
        }
      ],
      "ordinal": 0,
      "role": "primary",
      "server": "string"
    }
  ],
  "diskPerformance": [
    {
      "data": [
        {
          "readBytesPerSec": 0.1,
          "readIOPS": 0.1,
          "time": "string",
          "writeBytesPerSec": 0.1,
          "writeIOPS": 0.1
        }
      ],
      "ordinal": 0,
      "role": "primary",
      "server": "string"
    }
  ],
  "queriesPerSecond": [
    {
      "data": [
        {
          "time": "string",
          "tps": 0.1
        }
      ],
      "ordinal": 0,
      "role": "primary",
      "server": "string"
    }
  ],
  "replication": [
    {
      "data": [
        {
          "lagSeconds": 0.1,
          "time": "string"
        }
      ],
      "ordinal": 0,
      "role": "primary",
      "server": "string"
    }
  ],
  "storage": [
    {
      "data": [
        {
          "databaseSizeBytes": 0.1,
          "diskTotalBytes": 0.1,
          "diskUsedBytes": 0.1,
          "time": "string"
        }
      ],
      "ordinal": 0,
      "role": "primary",
      "server": "string"
    }
  ]
}