HIhiyd
Push

Report a successful band drain (or that the band was unpaired)

Feeds the band sync nudges. Does not count as the app being in the foreground.

post/api/push/sync-report

Request

  • Base URL
    https://api.hiyd.ai
  • Auth
    HTTP bearer

Request body

installation_idstring required
tracker_keystring nullable
drained_atstring date-time

required unless paired is false

records_receivedinteger nullable
battery_percentinteger nullable
chargingboolean nullable
used_sectorsinteger nullable
total_sectorsinteger nullable
triggerstring nullable
pairedboolean

Response

{ episode_closed, unpaired }. episode_closed: this report ended a stale episode. unpaired: this report (paired false) marked the band unpaired. It is false when the unpair came from an installation that does not hold the band (the band's latest drain came from another installation that is still registered) and names no band, or a different one: it is then ignored, and the app should report it again later.

Changes

No recorded changes to this operation across all 1 revision of this API.