Robot Metrics
APIs for retrieving KPI and telemetry metrics from robots.
Task Status Metrics
TaskManagerConfig lists configured tasks. TaskRunStatusList reports the latest-known run for
each reported task, including completed, canceled and failed runs.
List Available Metrics
- Cloud
- Local
Returns the system metric types known to this Cloud deployment, plus the requested robot's configured Custom KPI names.
Endpoint
GET /robots/metrics?robotId={robotId}
Request Headers
{
"authorization": "bearer <access_token>"
}
Query Parameters
- robotId (string, optional): The unique identifier of the robot. Without it, only the system metric types are listed.
Response Example
{
"metrics": [
{ "metricType": 1, "metricName": "Cpu" },
{ "metricType": 2, "metricName": "Ram" },
{ "metricType": 3, "metricName": "Disk" },
{ "metricType": 4, "metricName": "Battery" },
{ "metricType": 5, "metricName": "Odometry" },
{ "metricType": 6, "metricName": "Traffic" },
{ "metricType": 7, "metricName": "Storage" },
{ "metricType": 8, "metricName": "LicenseExpired" },
{ "metricType": 13, "metricName": "AgentHw" },
{ "metricType": 14, "metricName": "AgentSw" },
{ "metricType": 15, "metricName": "Recordings" },
{ "metricType": 16, "metricName": "Components" },
{ "metricType": 17, "metricName": "Configuration" },
{ "metricType": 18, "metricName": "Position" },
{ "metricType": 19, "metricName": "Network" },
{ "metricType": 20, "metricName": "License" },
{ "metricType": 21, "metricName": "Gpu" },
{ "metricType": 22, "metricName": "Devices" },
{ "metricType": 23, "metricName": "Nav2" },
{ "metricType": 24, "metricName": "RosEntity" },
{ "metricType": 25, "metricName": "Security" },
{ "metricType": 26, "metricName": "RosConfig" },
{ "metricType": 27, "metricName": "Wifi" },
{ "metricType": 28, "metricName": "Ping" },
{ "metricType": 29, "metricName": "RecordingProfileConfig" },
{ "metricType": 30, "metricName": "AgentOperationalState" },
{ "metricType": 31, "metricName": "UserKpiSettingsConfig" },
{ "metricType": 32, "metricName": "Thermal" },
{ "metricType": 33, "metricName": "ResourcesStorage" },
{ "metricType": 34, "metricName": "DockerRegistryConfig" },
{ "metricType": 35, "metricName": "NotificationSettingsConfig" },
{ "metricType": 36, "metricName": "TaskManagerConfig" },
{ "metricType": 37, "metricName": "TaskRunStatus" },
{ "metricType": 38, "metricName": "DebugSettingsConfig" },
{ "metricType": 39, "metricName": "LocalSessionInfo" },
{ "metricType": 40, "metricName": "TaskRunStatusList" },
{ "metricType": 43, "metricName": "SidecarStatus" },
{ "metricType": 44, "metricName": "RtspStreamingProfileConfig" },
{ "metricType": 45, "metricName": "RtspStreamingStatus" },
{ "metricType": 100, "metricName": "Apples" }
]
}
The catalog describes known metric types; listing a type does not guarantee a current value for
that robot. The catalog can vary with the deployed API version. Entries with metricType: 100
use the configured Custom KPI name, so several entries can share type 100.
Metrics are identified by their numeric metricType ID, not by metricName. Pass the ID as
metricId to Get Robot Metric. metricName is only a label, except for Custom
KPIs (100), where it selects the KPI.
On Cloud, Get Robot Metric returns a value only for the types listed in
Supported Metric Types. Every other type in this catalog always returns
404.
Common Errors
401: bearer token is missing or invalid.404:robotIdwas given, and the robot was not found or is not accessible to the caller.
Returns the metric types known to the local agent.
Listing a type does not guarantee a current value. A value read can return 404 when the Agent has
no matching value. The catalog can vary with the Agent version. Type 100 is listed as Custom;
supply a KPI name when reading its value.
Endpoint
GET /robots/metrics