Report Battery Telemetry

Cloud Mock

https://mock.apidog.com/m1/479670-0-default

POST

/v1/telemetry/BATTERY

Batch upload telemetry data points, with a maximum of 1,000 data points per request.

All the attributes must be sent.

In case the device was offline (is_online is set to false) and therefore no data was available, set all nullable attributes to null.
In case the device was online, all telemetry items must be supplied and must not be null.

The server will respond with a 200 in the majority of cases.
The response will list the status of saving each data point, using the same index each item had in the request.
If an item's status is FAILED, please correct the issue and resend it.

If the server does not understand the format of the request (i.e. the body is missing a list), then it will respond with a 400.

Request

Authorization

Provide your bearer token in the

Authorization

header when making requests to protected resources.

Example:

Authorization: Bearer ********************

Body Params application/json

Example

{
    "telemetry": [
        {
            "start_time": "2019-08-24T14:15:22Z",
            "duration_s": 0,
            "device_id": "string",
            "last_is_online": true,
            "last_mode": "BACKUP",
            "battery_last_power_charge_w": 0,
            "battery_last_power_discharge_w": 0,
            "battery_total_energy_charge_wh": 0,
            "battery_total_energy_discharge_wh": 0,
            "battery_last_stored_energy_wh": 0,
            "battery_last_capacity_energy_wh": 0,
            "battery_last_state_of_charge_percentage": 0,
            "battery_last_state_of_health_percentage": 0,
            "is_weather_alarm_active": true,
            "last_is_grid_online": true,
            "home_total_energy_wh": 0,
            "home_last_power_w": 0,
            "solar_total_energy_wh": 0,
            "solar_last_power_w": 0,
            "oem_raw_data": {
                "oem_identifier": "string"
            }
        }
    ]
}

Request Code Samples

Shell

JavaScript

Java

Swift

PHP

Python

HTTP

Objective-C

Ruby

OCaml

Dart

curl --location --request POST 'https://mock.apidog.com/m1/479670-0-default/v1/telemetry/BATTERY' \
--header 'Content-Type: application/json' \
--data-raw '{
    "telemetry": [
        {
            "start_time": "2019-08-24T14:15:22Z",
            "duration_s": 0,
            "device_id": "string",
            "last_is_online": true,
            "last_mode": "BACKUP",
            "battery_last_power_charge_w": 0,
            "battery_last_power_discharge_w": 0,
            "battery_total_energy_charge_wh": 0,
            "battery_total_energy_discharge_wh": 0,
            "battery_last_stored_energy_wh": 0,
            "battery_last_capacity_energy_wh": 0,
            "battery_last_state_of_charge_percentage": 0,
            "battery_last_state_of_health_percentage": 0,
            "is_weather_alarm_active": true,
            "last_is_grid_online": true,
            "home_total_energy_wh": 0,
            "home_last_power_w": 0,
            "solar_total_energy_wh": 0,
            "solar_last_power_w": 0,
            "oem_raw_data": {
                "oem_identifier": "string"
            }
        }
    ]
}'

Responses

🟢200OK

application/json

Body

Example

[
    {
        "status": "FAILED",
        "message": "string"
    }
]

🟠400Invalid input

🟠404Record not found

Modified at 2025-06-12 14:19:55

Read Programs

Overview