- Overview
- Important concepts
- Authentication
- Enrollment process
- End-user app design
- Monitoring / Telemetry
- Control
- Mobile App API
- Cloud API
- Sites
- Commissioning
- Sessions
- Commands
- Programs
- Telemetry
- Webhooks
Read Event
Cloud Mock
Cloud Mock
GET
/v1/site/{siteId}/event/{id}
Request
Authorization
Provide your bearer token in the
Authorization
header when making requests to protected resources.Example:
Authorization: Bearer ********************
Path Params
siteId
string
required
id
string
required
Request samples
Shell
JavaScript
Java
Swift
Go
PHP
Python
HTTP
C
C#
Objective-C
Ruby
OCaml
Dart
R
Request Request Example
Shell
JavaScript
Java
Swift
curl --location --request GET 'https://mock.apidog.com/m1/479670-0-default/v1/site//event/'
Responses
🟢200Success
application/json
Body
id
string <uuid>
read-onlyrequired
program_id
string <uuid>
required
site_id
string
required
starts_at
string <date-time>
read-onlyrequired
ends_at
string <date-time> | null
read-onlyrequired
duration_s
number | null
required
schedule
array [object {6}]
required
device_ids
array[string]
required
starts_at
string <date-time>
read-onlyrequired
ends_at
string <date-time> | null
read-onlyrequired
duration_s
number | null
read-onlyrequired
is_preparatory_action
boolean
read-onlyrequired
mode
enum<string>
required
Allowed values:
BACKUPCHARGEDISCHARGESAVINGSSELF_CONSUMPTIONSTANDBY
device_settings
array[object (EventBatterySettings) {3}]
deprecated
device_id
string
deprecated
backup_reserve_percentage
integer