Post robot status summaries (beta)
const url = 'https://api.example.yas/v1/robots/summaries/status';const options = { method: 'POST', headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'}, body: '{"partnerId":"partner","schemaVersion":"2026-11","sourceSystem":"partner-export","records":[{"robotId":"rbt_example","recordedAt":"2026-10-15T10:00:05.000Z","timezone":"Asia/Hong_Kong","periodSeconds":5,"cloudLink":"up","wifiRssiDbm":-62,"speedAvgMps":0.4}]}'};
try { const response = await fetch(url, options); const data = await response.json(); console.log(data);} catch (error) { console.error(error);}curl --request POST \ --url https://api.example.yas/v1/robots/summaries/status \ --header 'Authorization: Bearer <token>' \ --header 'Content-Type: application/json' \ --data '{ "partnerId": "partner", "schemaVersion": "2026-11", "sourceSystem": "partner-export", "records": [ { "robotId": "rbt_example", "recordedAt": "2026-10-15T10:00:05.000Z", "timezone": "Asia/Hong_Kong", "periodSeconds": 5, "cloudLink": "up", "wifiRssiDbm": -62, "speedAvgMps": 0.4 } ] }'Beta. Post 1 to 1000 status records with the server key. Each record covers 1 to 5 seconds and needs robotId, recordedAt, timezone, and periodSeconds. Connectivity, movement, and pose fields are optional. xM, yM, and zM are metres in the map frame. Prefer a mapId you already completed. A missing map is still stored. YAS counts online and active time from operatingMode. Online counts only an explicit idle, autonomous, manual, or charging. A window that omits operatingMode is not online and not active. idle and charging are online and not active. Active time is autonomous or manual. moving is recorded on its own and is not added to those totals. The robot must already exist for this partnerId. An unknown robotId is 404; nothing in the call is stored. An empty list, a missing field, periodSeconds outside 1 to 5, or an unknown operatingMode is 400. More than 1000 records is 413. Records have no id. Post the same window again and YAS stores another row. accepted equals the number of records.
Authorizations
Section titled “Authorizations”Request Bodyrequired
Section titled “Request Bodyrequired”object
Partner id. It must match the server key.
Schema version of this body. Example: 2026-11.
Name of the system that sent this body. Example: partner-export.
Firmware version at the time of this call.
Extra fields from the partner. Stored as sent.
object
Status windows in this call. Send 1 to 1000.
object
Robot id. The robot must already exist.
When this window ended, as ISO-8601 UTC.
IANA timezone. Example: Asia/Hong_Kong.
Length of this window in seconds. Allowed range is 1 to 5.
True when main power was present during the window.
Controller state. Example: ready.
Cloud link during the window. Example: up.
Wi-Fi signal strength in dBm.
Access point or zone name.
Round-trip latency in milliseconds.
Packet loss as a percent.
How many times the link reconnected in the window.
Why the robot was offline. Send this when operatingMode is offline.
Distance travelled in this window, in metres.
Average speed in metres per second.
Highest speed in this window, in metres per second.
Localisation quality from 0 to 1.
Map this pose uses. Prefer a map already completed. A missing map is still stored.
X in the map frame. One unit is one metre.
Y in the map frame. One unit is one metre.
Z in the map frame when the partner has height. One unit is one metre.
How the robot was working. offline is not online. idle and charging are online and not active. autonomous and manual are online and active. Omit the field and the window is not online and not active.
True when the robot was in motion during the window. This is separate from operatingMode and is not added to online or active time.
True when the robot was in a space shared with people.
Example
{ "partnerId": "partner", "schemaVersion": "2026-11", "sourceSystem": "partner-export", "records": [ { "robotId": "rbt_example", "recordedAt": "2026-10-15T10:00:05.000Z", "timezone": "Asia/Hong_Kong", "periodSeconds": 5, "cloudLink": "up", "wifiRssiDbm": -62, "speedAvgMps": 0.4 } ]}Responses
Section titled “Responses”Status records stored. accepted equals the number of records.
object
Example
{ "accepted": 1}400The records list is empty, a required field is missing, `periodSeconds` is outside 1 to 5, or `operatingMode` is not one of the allowed values.
object
Stable error code. No stack trace.
Example
{ "error": "invalid_body"}401The server key is missing or wrong.
object
Stable error code. No stack trace.
Example
{ "error": "invalid_credentials"}403A server key may be limited to vehicles, robots, or both. A call outside that limit is 403 `forbidden` and stores nothing. `identity_mismatch` means `partnerId` does not match the server key.
object
Stable error code. No stack trace.
Example
{ "error": "forbidden"}404Unknown `robotId`. Nothing in this call is stored.
object
Stable error code. No stack trace.
Example
{ "error": "not_found"}413More than 1000 records. Nothing is stored.
object
Stable error code. No stack trace.
Example
{ "error": "payload_too_large"}