REST reference

/telemetry

7 addresses under /telemetry.All families · Refusal codes

Convergence

GETon demand/telemetry/convergence

barrierread-only
continuousread-only
correctionsread-only
heartbeatMsread-only
revisionread-only

Example response

{
  "barrier": 0,
  "continuous": [
    "/channel/{kind}/{index}/align/measurement",
    "/channel/{kind}/{index}/eq/bands/sort",
    "/channel/{kind}/{index}/hrp/report",
    "/channel/{kind}/{index}/hrp/reset",
    "/channel/{kind}/{index}/meter",
    "/channel/{kind}/{index}/speakerAlign",
    "/channel/{kind}/{index}/spectrum",
    "/channelConfigs",
    "/channelConfigs/{id}",
    "/channelConfigs/{id}/apply/{kind}/{index}",
    "/clipboard/{slot}/paste",
    "/clock",
    "/clock/force",
    "/clock/ownership",
    "/clock/ownership/reference",
    "/clock/references",
    "/clock/warnings",
    "/console/bpm/tap",
    "/cue/clear",
    "/discovery/scan",
    "/history",
    "/history/cursor",
    "/history/cursor/redo",
    "/history/cursor/undo",
    "/history/entries/{id}",
    "/history/entries/{id}/revert",
    "/measurement/plan",
    "/measurement/run",
    "/meters",
    "/patchbay/disconnect",
    "/patchbay/external",
    "/patchbay/external/{edgeId}",
    "/patches",
    "/patches/{id}",
    "/patches/{id}/apply",
    "/record/start",
    "/record/stop",
    "/rme/totalmix/reassert",
    "/safety/loop",
    "/scenes",
    "/scenes/{id}",
    "/scenes/{id}/recall",
    "/sessions",
    "/sessions/{id}",
    "/sessions/{id}/apply",
    "/streams/{id}/demand",
    "/surface/autodetect",
    "/takes/{id}/export",
    "/takes/{id}/render",
    "/telemetry/convergence",
    "/telemetry/convergence/corrections",
    "/telemetry/convergence/corrections",
    "/telemetry/latency",
    "/telemetry/process",
    "/telemetry/rt",
    "/telemetry/subscription",
    "/vsc/eject"
  ],
  "corrections": 0,
  "heartbeatMs": 1000,
  "revision": 0
}

GETon demand/telemetry/convergence/corrections

entriesread-only
totalread-only

Example response

{
  "entries": [],
  "total": 0
}

Latency

GETon demand/telemetry/latency

atread-only
reportread-only

Example response

{
  "at": null,
  "report": null
}

Perf

GET/telemetry/perf

enabledread-only
opsread-only

Example response

{
  "enabled": false,
  "ops": []
}

Process

GETon demand/telemetry/process

activeResourcesread-only
cpuPercentread-only
cpuSystemPercentread-only
cpuUserPercentread-only
eventLoopLagMaxMsread-only
eventLoopLagMeanMsread-only
eventLoopLagP99Msread-only
externalMbread-only
heapTotalMbread-only
heapUsedMbread-only
rssMbread-only
uptimeSread-only

Example response

{
  "activeResources": 0,
  "cpuPercent": 0,
  "cpuSystemPercent": 0,
  "cpuUserPercent": 0,
  "eventLoopLagMaxMs": 0,
  "eventLoopLagMeanMs": 0,
  "eventLoopLagP99Ms": 0,
  "externalMb": 0,
  "heapTotalMb": 0,
  "heapUsedMb": 0,
  "rssMb": 0,
  "uptimeS": 0
}

Rt

GETon demand/telemetry/rt

No fields observed on the reference rig.

Subscription

GET/telemetry/subscription

convergenceread-only
latencyread-only
metersread-only
processread-only
rtread-only
rtaInstancesread-only
spectrumread-only

Example response

{
  "convergence": 0,
  "latency": 0,
  "meters": 0,
  "process": 0,
  "rt": 0,
  "rtaInstances": 0,
  "spectrum": 0
}