Flip Energy API
  • Overview
  • Important concepts
  • Authentication
  • Enrollment process
  • Recommended homeowner app design
  • Monitoring / Telemetry
  • Control
  • Mobile App API
  • Cloud API
    • Sites
    • Commissioning
    • Telemetry
      • Report Battery TelemetryPOST
    • Commands
    • Webhooks
logoPowered by Apidog

    Report Battery Telemetry

    Developing
    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

    Body Params application/json
    start_time
    string <date-time>
    required

    Start time of the reporting interval of this report

    duration_s
    integer 
    required

    Reporting interval duration, in seconds

    telemetry
    $ref(#/definitions/1580390)[]
    required

    A per-device telemetry report

    Could not resolve '#/definitions/1580390'
    #/definitions/1580390
    optional
    Could not resolve '#/definitions/1580390'
    Example
    Not configured

    Request samples

    Responses

    OK(200)
    HTTP Code: 200
    Content Type : JSONapplication/json
    Data Schema
    array of:
    status
    enum<string> 
    required
    Allowed values:
    FAILEDOK
    message
    string  | null 
    required
    Example
    [
  {
    "status": "FAILED",
    "message": "string"
  }
]
    Last modified: 4 months ago