List Noise Thresholds

List all Noise Thresholds on your Noise Sensor

List Noise Thresholds set on Device

GET https://connect.getseam.com/noise_sensors/noise_thresholds/list

Query Parameters

Name	Type	Description
device_id*	String	Device id of a device the noise thresholds are set on

Headers

Name	Type	Description
Authorization*	String	Bearer <API_KEY>

200: OK

{
  "noise_thresholds": [
    {
      "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": "22:00:00[America/Los_Angeles]",
      "ends_daily_at": "06:00:00[America/Los_Angeles]",
    },
    {
      "noise_threshold_id": "678ccd98-7036-402f-a42c-e66f55575566",
      "device_id": "123e4567-e89b-12d3-a456-426614174000",
      "name": "builtin_normal_hours",
      "noise_threshold_decibels": 75,
      "starts_daily_at": "06:00:00[America/Los _Angeles]",
      "ends_daily_at": "22:00:00[America/Los_Angeles]",
    },
  ],
  "ok": true
}

Code Example

Python

seam.noise_sensors.noise_thresholds.list("123e4567-e89b-12d3-a456-426614174000")

# [
    # {
    #     "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": "22:00:00[America/Los_Angeles]",
    #     "ends_daily_at": "06:00:00[America/Los_Angeles]",
    # },
    # {
    #     "noise_threshold_id": "678ccd98-7036-402f-a42c-e66f55575566",
    #     "device_id": "123e4567-e89b-12d3-a456-426614174000",
    #     "name": "builtin_normal_hours",
    #     "noise_threshold_decibels": 75,
    #     "starts_daily_at": "06:00:00[America/Los _Angeles]",
    #     "ends_daily_at": "22:00:00[America/Los_Angeles]",
    # },
# ]

PHP

$seam->noise_sensors->noise_thresholds->list("123e4567-e89b-12d3-a456-426614174000")

# [
    # {
    #     "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": "22:00:00[America/Los_Angeles]",
    #     "ends_daily_at": "06:00:00[America/Los_Angeles]",
    # },
    # {
    #     "noise_threshold_id": "678ccd98-7036-402f-a42c-e66f55575566",
    #     "device_id": "123e4567-e89b-12d3-a456-426614174000",
    #     "name": "builtin_normal_hours",
    #     "noise_threshold_decibels": 75,
    #     "starts_daily_at": "06:00:00[America/Los _Angeles]",
    #     "ends_daily_at": "22:00:00[America/Los_Angeles]",
    # },
# ]

Parameters

device_id

type: string

ID of the Device the Noise Thresholds are set on

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

{
  "noise_thresholds": [
    {
      "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": "22:00:00[America/Los_Angeles]",
      "ends_daily_at": "06:00:00[America/Los_Angeles]"
    },
    {
      "noise_threshold_id": "678ccd98-7036-402f-a42c-e66f55575566",
      "device_id": "123e4567-e89b-12d3-a456-426614174000",
      "name": "builtin_normal_hours",
      "noise_threshold_decibels": 75,
      "starts_daily_at": "06:00:00[America/Los_Angeles]",
      "ends_daily_at": "22:00:00[America/Los_Angeles]"
    }
  ]
}