Comment on page

Create Noise Thresholds

Create a Noise Threshold on your Noise Sensor

post
https://connect.getseam.com
/noise_sensors/noise_thresholds/create
Create Noise Threshold on Device
Code Example
Python
PHP
seam.noise_sensors.noise_thresholds.create(
    device_id="123e4567-e89b-12d3-a456-426614174000",
    starts_daily_at="20:00:00[America/Los_Angeles]",
    ends_daily_at="06:00:00[America/Los_Angeles]",
    noise_threshold_decibels=70,
)
​
# {
#   "noise_threshold_id": "792263f8-1660-4cf9-a6c6-054d23b78d86",
#   "device_id": "123e4567-e89b-12d3-a456-426614174000",
#   "name": "builtin_quiet_hours",
#   "noise_threshold_decibels": 70,
#   "starts_daily_at": "20:00:00[America/Los_Angeles]",
#   "ends_daily_at": "06:00:00[America/Los_Angeles]",
# }
$seam->noise_sensors->noise_thresholds->create(
  device_id: "123e4567-e89b-12d3-a456-426614174000",
  starts_daily_at: "20:00:00[America/Los_Angeles]",
  ends_daily_at: "06:00:00[America/Los_Angeles]",
  noise_threshold_decibels: 70,
);
​
# {
#   "noise_threshold_id": "792263f8-1660-4cf9-a6c6-054d23b78d86",
#   "device_id": "123e4567-e89b-12d3-a456-426614174000",
#   "name": "builtin_quiet_hours",
#   "noise_threshold_decibels": 70,
#   "starts_daily_at": "20:00:00[America/Los_Angeles]",
#   "ends_daily_at": "06:00:00[America/Los_Angeles]",
# }
Parameters
device_id
string
Device id of a device to create a noise threshold on
name
string
Name of the Noise Threshold
starts_daily_at
​Seam Time of Day​
Timestamp of when the Noise Threshold becomes active daily
ends_daily_at
​Seam Time of Day​
Timestamp of when the Noise Threshold becomes inactive daily
noise_threshold_decibels
number
The noise level in decibels
noise_threshold_nrs
number, optional
Noise Level in Noiseaware Noise Risk Score (NRS) (only relevant for Noiseaware sensors)
Response
This section shows the JSON response returned by the API. Since each language encapsulates this response inside objects specific to that language and/or implementation, the actual type in your language might differ from what’s written here.
JSON format
JSON
{
  "action_attempt": {
    "status": "pending",
    "action_type": "CREATE_NOISE_THRESHOLD",
    "action_attempt_id": "c10e3db5-a5a2-47f2-a76f-48379ed9cd22",
    "result": null,
    "error": null
  },
  "ok": true
}

List Noise Thresholds

Update Noise Threshold

Last modified 3mo ago

`device_id`	string	Device id of a device to create a noise threshold on
`name`	string	Name of the Noise Threshold
`starts_daily_at`	Seam Time of Day	Timestamp of when the Noise Threshold becomes active daily
`ends_daily_at`	Seam Time of Day	Timestamp of when the Noise Threshold becomes inactive daily
`noise_threshold_decibels`	number	The noise level in decibels
`noise_threshold_nrs`	number, optional	Noise Level in Noiseaware Noise Risk Score (NRS) (only relevant for Noiseaware sensors)