Noise Thresholds

The noise_threshold Object

Represents a noise threshold for a noise sensor. Thresholds represent the limits of noise tolerated at a property, which can be customized for each hour of the day. Each device has its own default thresholds, but you can use the Seam API to modify them.

A noise threshold resource.

{
  "device_id": "69b9e908-039b-413a-904e-5edee653ca27",
  "ends_daily_at": "09:00:00[America/Los_Angeles]",
  "name": "My Noise Threshold",
  "noise_threshold_decibels": 21,
  "noise_threshold_id": "f8cef69d-625f-464c-aed4-287c06e0d7fe",
  "noise_threshold_nrs": 5,
  "starts_daily_at": "07:00:00[America/Los_Angeles]"
}

Properties

device_id UUID

Unique identifier for the device that contains the noise threshold.

ends_daily_at String

Time at which the noise threshold should become inactive daily.

name String

Name of the noise threshold.

noise_threshold_decibels Number

Noise level in decibels for the noise threshold.

noise_threshold_id UUID

Unique identifier for the noise threshold.

noise_threshold_nrs Number

Noise level in Noiseaware Noise Risk Score (NRS) for the noise threshold. This parameter is only relevant for Noiseaware sensors.

starts_daily_at String

Time at which the noise threshold should become active daily.

Events

noise_sensor.noise_threshold_triggered

Extended periods of noise or noise exceeding a threshold were detected.

Properties

connected_account_custom_metadata Record

Custom metadata of the connected account, present when connected_account_id is provided.

connected_account_id UUID

ID of the connected account associated with the event.

created_at Datetime

Date and time at which the event was created.

device_custom_metadata Record

Custom metadata of the device, present when device_id is provided.

device_id UUID

ID of the affected device.

event_id UUID

ID of the event.

event_type Enum

Value: noise_sensor.noise_threshold_triggered

minut_metadata Record

Metadata from Minut.

noise_level_decibels Number

Detected noise level in decibels.

noise_level_nrs Number

Detected noise level in Noiseaware Noise Risk Score (NRS).

noise_threshold_id UUID

ID of the noise threshold that was triggered.

noise_threshold_name String

Name of the noise threshold that was triggered.

noiseaware_metadata Record

Metadata from Noiseaware.

occurred_at Datetime

Date and time at which the event occurred.

workspace_id UUID

ID of the workspace associated with the event.

Endpoints

/noise_sensors/noise_thresholds/create

Creates a new noise threshold for a noise sensor. Thresholds represent the limits of noise tolerated at a property, which can be customized for each hour of the day. Each device has its own default thresholds, but you can use the Seam API to modify them.

/noise_sensors/noise_thresholds/delete

Deletes a noise threshold from a noise sensor.

/noise_sensors/noise_thresholds/get

Returns a specified noise threshold for a noise sensor.

/noise_sensors/noise_thresholds/list

Returns a list of all noise thresholds for a noise sensor.

/noise_sensors/noise_thresholds/update

Updates a noise threshold for a noise sensor.