Specialized APIsSensor Insights
API Quick Reference
Sensor Insights API Quick Reference
Here is a quick reference to use for finding API endpoints for Sensor Insights
Sensors
| Http Request | Description |
|---|---|
| POST /dm/v1/devices/sensors/actions/query | Query sensors on an account |
| POST /dm/v1/devices/sensors/onboard | Onboard a sensor |
| POST /dm/v1/devices/sensors/onboard/status/actions/query | Get a sensor's onboarding status |
| POST /dm/v1/devices/sensors/offboard | Offboard a sensor |
| POST /dm/v1/devices/sensors/offboard/status/actions/query | Get a sensor's offboarding status |
Device Profiles
| Http Request | Description |
|---|---|
| POST /dm/v1/deviceConfigurationProfiles | Create a device profile |
| PATCH /dm/v1/deviceConfigurationProfiles | Partially update a device profile |
| DELETE /dm/v1/deviceConfigurationProfiles | Delete a device profile |
| POST /dm/v1/deviceConfigurationProfiles/actions/query | Query an individual device's profile |
Devices
| Http Request | Description |
|---|---|
| POST /dm/v1/devices/actions/query | List all device details on the account |
| PATCH /dm/v1/devices | Partially update a device |
| POST /dm/v1/devices/lastreported | Get last reported information for a device |
| POST /dm/v1/devices/actions/set | Set device configuration |
| POST /dm/v1/devices/experience/actions/query | List the device experience |
| POST /dm/v1/devices/networkexperience/actions/query | List the network experience |
Gateways
| Http Request | Description |
|---|---|
| POST /dm/v1/devices/gateways/actions/query | Get gateway information |
Smart Alerts
| Http Request | Description |
|---|---|
| POST /dm/v1/smartAlerts/actions/query | Retrieve a smart alert |
| PATCH /dm/v1/smartAlerts | Partiallty update a smart alert |
| POST /dm/v1/smartAlerts/actions/bulkupdate | Bulk update a smart alert |
Smart Alert Metrics
| Http Request | Description |
|---|---|
| POST /dm/v1/smartAlerts/actions/metrics | Retrieve a tally of alerts reported by sensors in a recent daily period, up to 30 days |
Rules
| Http Request | Description |
|---|---|
| POST /dm/v1/rules/actions/query | Retrieve a rule |
| POST /dm/v1/rules | Overwrite a rule |
Health Score
| Http Request | Description |
|---|---|
| POST /dm/v1/healthscore/summary | Get a summary of device health scores |
| POST /dm/v1/healthscore/network | Get a summary of the network health scores |
Notification Groups
| Http Request | Description |
|---|---|
| POST /dm/v1/notificationGroups | Create a notification group |
| PATCH /dm/v1/notificationGroups | Partially update a notification group |
| POST /dm/v1/notificationGroups/actions/add-users | Add users to a notification group |
| POST /dm/v1/notificationGroups/actions/remove-users | Remove users from a notification group |
| POST /dm/v1/notificationGroups/actions/query | Retrieve a notification group |
| DELETE /dm/v1/notificationGroups | Delete a notification group |
Users
| Http Request | Description |
|---|---|
| POST /dm/v1/users | Create a user profile |
| PATCH /dm/v1/users | Partially update a user profile |
| POST /dm/v1/users/actions/query | Retrieve all user profiles |
| DELETE /dm/v1/users | Delete a user profile |