# 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](/docs/specialized-apis/sensor-insights/api-endpoints/sensors/sensorinsightslistsensordevicesrequest) | Query sensors on an account | | [POST /dm/v1/devices/sensors/onboard](/docs/specialized-apis/sensor-insights/api-endpoints/sensors/sensorinsightsonboardsensorrequest) | Onboard a sensor | | [POST /dm/v1/devices/sensors/onboard/status/actions/query](/docs/specialized-apis/sensor-insights/api-endpoints/sensors/sensorinsightssensoronboardstatusrequest) | Get a sensor's onboarding status | | [POST /dm/v1/devices/sensors/offboard](/docs/specialized-apis/sensor-insights/api-endpoints/sensors/sensorinsightsoffboardsensorrequest) | Offboard a sensor | | [POST /dm/v1/devices/sensors/offboard/status/actions/query](/docs/specialized-apis/sensor-insights/api-endpoints/sensors/sensorinsightssensoroffboardingstatusrequest) | Get a sensor's offboarding status | ## Device Profiles | Http Request | Description | | ---------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------ | | [POST /dm/v1/deviceConfigurationProfiles](/docs/specialized-apis/sensor-insights/api-endpoints/device-profiles/createaprofile) | Create a device profile | | [PATCH /dm/v1/deviceConfigurationProfiles](/docs/specialized-apis/sensor-insights/api-endpoints/device-profiles/updateaprofile) | Partially update a device profile | | [DELETE /dm/v1/deviceConfigurationProfiles](/docs/specialized-apis/sensor-insights/api-endpoints/device-profiles/deleteaprofile) | Delete a device profile | | [POST /dm/v1/deviceConfigurationProfiles/actions/query](/docs/specialized-apis/sensor-insights/api-endpoints/device-profiles/queryaprofile) | Query an individual device's profile | ## Devices | Http Request | Description | | ---------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------ | | [POST /dm/v1/devices/actions/query](/docs/specialized-apis/sensor-insights/api-endpoints/devices/sensorinsightslistdevicesrequest) | List all device details on the account | | [PATCH /dm/v1/devices](/docs/specialized-apis/sensor-insights/api-endpoints/devices/sensorinsightspatchdevicerequest) | Partially update a device | | [POST /dm/v1/devices/lastreported](/docs/specialized-apis/sensor-insights/api-endpoints/devices/sensorinsightslastreportedtimerequest) | Get last reported information for a device | | [POST /dm/v1/devices/actions/set](/docs/specialized-apis/sensor-insights/api-endpoints/devices/sensorinsightsdeviceactionsetrequest) | Set device configuration | | [POST /dm/v1/devices/experience/actions/query](/docs/specialized-apis/sensor-insights/api-endpoints/devices/sensorinsightslistdeviceexperiencehistoryrequest) | List the device experience | | [POST /dm/v1/devices/networkexperience/actions/query](/docs/specialized-apis/sensor-insights/api-endpoints/devices/sensorinsightslistnetworkexperiencehistoryrequest) | List the network experience | ## Gateways | Http Request | Description | | --------------------------------------------------------------------------------------------------------------------- | ----------------------- | | [POST /dm/v1/devices/gateways/actions/query](/docs/specialized-apis/sensor-insights/api-endpoints/gateways/sensorinsightslistgatewaydevicesrequest) | Get gateway information | ## Smart Alerts | Http Request | Description | | ------------------------------------------------------------------------------------------------------------------- | ------------------------------- | | [POST /dm/v1/smartAlerts/actions/query](/docs/specialized-apis/sensor-insights/api-endpoints/smart-alerts/sensorinsightslistsmartalertsrequest) | Retrieve a smart alert | | [PATCH /dm/v1/smartAlerts](/docs/specialized-apis/sensor-insights/api-endpoints/smart-alerts/sensorinsightspatchsmartalertrequest) | Partiallty update a smart alert | | [POST /dm/v1/smartAlerts/actions/bulkupdate](/docs/specialized-apis/sensor-insights/api-endpoints/smart-alerts/sensorinsightsbulkupdate) | Bulk update a smart alert | ## Smart Alert Metrics | Http Request | Description | | ------------------------------------------------------------------------------------------------------------------- | ------------------------------- | | [POST /dm/v1/smartAlerts/actions/metrics](/docs/specialized-apis/sensor-insights/api-endpoints/smart-alerts/sensorinsightsmetricsquery) | 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](/docs/specialized-apis/sensor-insights/api-endpoints/rules/sensorinsightslistrulesrequest) | Retrieve a rule | | [POST /dm/v1/rules](/docs/specialized-apis/sensor-insights/api-endpoints/rules/sensorinsightsoverwriterulerequest) | Overwrite a rule | ## Health Score | Http Request | Description | | -------------------------------------------------------------------------------------------------------------------- | ------------------------------------------ | | [POST /dm/v1/healthscore/summary](/docs/specialized-apis/sensor-insights/api-endpoints/health-score/sensorinsightshealthscoresummary) | Get a summary of device health scores | | [POST /dm/v1/healthscore/network](/docs/specialized-apis/sensor-insights/api-endpoints/health-score/sensorinsightsgetnetworkhealthscoreresponse) | Get a summary of the network health scores | ## Notification Groups | Http Request | Description | | --------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------- | | [POST /dm/v1/notificationGroups](/docs/specialized-apis/sensor-insights/api-endpoints/notification-groups/sensorinsightscreatenotificationgrouprequest) | Create a notification group | | [PATCH /dm/v1/notificationGroups](/docs/specialized-apis/sensor-insights/api-endpoints/notification-groups/sensorinsightsupdatenotificationgrouprequest) | Partially update a notification group | | [POST /dm/v1/notificationGroups/actions/add-users](/docs/specialized-apis/sensor-insights/api-endpoints/notification-groups/sensorinsightsadduserstonotificationgrouprequest) | Add users to a notification group | | [POST /dm/v1/notificationGroups/actions/remove-users](/docs/specialized-apis/sensor-insights/api-endpoints/notification-groups/sensorinsightsremoveusersfromnotificationgrouprequest) | Remove users from a notification group | | [POST /dm/v1/notificationGroups/actions/query](/docs/specialized-apis/sensor-insights/api-endpoints/notification-groups/sensorinsightslistnotificationgrouprequest) | Retrieve a notification group | | [DELETE /dm/v1/notificationGroups](/docs/specialized-apis/sensor-insights/api-endpoints/notification-groups/sensorinsightsdeletenotificationgroup) | Delete a notification group | ## Users | Http Request | Description | | --------------------------------------------------------------------------------------------- | ------------------------------- | | [POST /dm/v1/users](/docs/specialized-apis/sensor-insights/api-endpoints/users/sensorinsightscreateuserrequest) | Create a user profile | | [PATCH /dm/v1/users](/docs/specialized-apis/sensor-insights/api-endpoints/users/sensorinsightsupdateuserrequest) | Partially update a user profile | | [POST /dm/v1/users/actions/query](/docs/specialized-apis/sensor-insights/api-endpoints/users/sensorinsightslistuserrequest) | Retrieve all user profiles | | [DELETE /dm/v1/users](/docs/specialized-apis/sensor-insights/api-endpoints/users/sensorinsightsdeleteuser) | Delete a user profile |