noiseMeterHistorySummary

GET

/api/v1/plugins/noise-meter/instances/{id}/history/summary

const url = 'https://example.com/api/v1/plugins/noise-meter/instances/2489E9AD-2EE2-8E00-8EC9-32D5F69181C0/history/summary?range=today';
const options = {method: 'GET'};

try {
  const response = await fetch(url, options);
  const data = await response.json();
  console.log(data);
} catch (error) {
  console.error(error);
}

curl --request GET \
  --url 'https://example.com/api/v1/plugins/noise-meter/instances/2489E9AD-2EE2-8E00-8EC9-32D5F69181C0/history/summary?range=today'

Descriptive statistics for the selected range: average and peak relative level, time in each band, warning events counted by the Player, the longest continuous loud run, and the loudest fifteen minutes. Screens are resolved from the caller’s own scope.

Parameters

Path Parameters

required

string format: uuid

Query Parameters

range

default: today

Allowed values: today yesterday 7d 30d

screenId

string format: uuid

One screen, authorized with the same screen scope as every other screen operation. Omitted means every screen the account may see.

string

IANA timezone for day boundaries. Unreadable values fall back to UTC.

Responses

200

Summary statistics

400

Range or screen is invalid

404

Instance or screen not found