Skip to content
ReflexDB

Instance metrics

GET
/databases/{id}/metrics
 
curl --request GET \
  --url https://api.reflexdb.cloud/v1/databases/2489E9AD-2EE2-8E00-8EC9-32D5F69181C0/metrics \
  --header 'Authorization: Bearer <token>'

Proxies and parses Prometheus metrics from the running instance. Returns query rates, snapshot size, and per-table row counts.

Authorizations

Section titled “Authorizations ”

Parameters

Section titled “ Parameters ”

Path Parameters

Section titled “Path Parameters ”
id
required
string format: uuid

Database ID

Responses

Section titled “ Responses ”

200

Section titled “200 ”

Prometheus metrics scraped from a running instance

Media type application/json
InstanceMetrics

Prometheus metrics scraped from a running instance

object
queriesOk
required

Total successful queries since start

number
queriesErr
required

Total failed queries since start

number
snapshotBytes
required

Current in-memory snapshot size in bytes

number
snapshotAgeSeconds
required

Seconds since last snapshot sync

number
swapCount
required

Total atomic snapshot swaps

number
tableRows
required

Row count per table

object
key
additional properties
number
queryDurationSum
required

Total query duration in seconds (for percentile calculation)

number
queryDurationCount
required

Total number of timed queries

number
Example generated
{
  "queriesOk": 1,
  "queriesErr": 1,
  "snapshotBytes": 1,
  "snapshotAgeSeconds": 1,
  "swapCount": 1,
  "tableRows": {
    "additionalProperty": 1
  },
  "queryDurationSum": 1,
  "queryDurationCount": 1
}

403

Section titled “403 ”

Default Response

Media type application/json
Error
object
error
required
string
message
string
Example generated
{
  "error": "example",
  "message": "example"
}

404

Section titled “404 ”

Default Response

Media type application/json
Error
object
error
required
string
message
string
Example generated
{
  "error": "example",
  "message": "example"
}

502

Section titled “502 ”

Default Response

Media type application/json
Error
object
error
required
string
message
string
Example generated
{
  "error": "example",
  "message": "example"
}

503

Section titled “503 ”

Default Response

Media type application/json
Error
object
error
required
string
message
string
Example generated
{
  "error": "example",
  "message": "example"
}