Fetch noise measurements

GET /data/noise/measurements

Get noise measurements for the selected instruments and time range.

Optionally choose which values to include and what period to recalculate results to.

The possible values are:

  • Leq
    • LAeq, LCeq, LZeq
    • LAE, LCE, LZE
    • LEX8
  • Peak
    • LAPeak, LCPeak, LZPeak
  • SPL Max
    • LAFMax, LASMax, LAIMax
    • LCFMax, LCSMax, LCIMax
    • LZFMax, LZSMax, LZIMax
  • Statistical Levels
    • LAF1, LAF5, LAF10, LAF50, LAF90, LAF95, LAF99
    • Not supported if Period is used. Only available from the measurements as recorded.
  • Moving Average
    • LeqT1Max, LeqT2Max
    • These fields will also add LeqT1Type and LeqT2Type to the results which include the friendly name of these types based on the settings.

 

If you specify an invalid or unavailable value, the server will ignore it.
If all specified values are invalid, the server will respond with an error.
If no values are specified, the server will return the default results (LAeq, LCPeak, LAFMax).

The maximum date range per request is 31 days. If you request a longer range, the server will respond with an error.
The default Period is the measurement period as configured in the instrument. See the settings for details.
The period can be set to anything between the measurement period and 1 day. If you request a period outside this range, the server will respond with an error.

Requires an API key with the data.noise:read scope.

Query parameters

  • instruments array[string] Required

    Serial numbers of selected instruments

  • start string(date-time) Required

    Start date and time for loading a range of data. Must be in UTC.

    This uses the ISO8601 format. For example, 2023-01-01T00:00:00Z is 1st January 2023 at midnight UTC.

  • end string(date-time) Required

    End date and time for loading a range of data. Must be in UTC.

    This uses the ISO8601 format. For example, 2023-01-01T00:00:00Z is 1st January 2023 at midnight UTC.

  • period string(duration)

    Period to recalculate measurement samples to.

    This cannot be less than the recorded measurement period.

    This uses the ISO8601 duration format. For example, P1D is 1 day, PT1H is 1 hour, PT5M is 5 minutes.

  • values array[string]

    Names of selected values to include in results

    Default value is ["LAeq", "LCPeak", "LAFMax"].

Responses

  • 200 application/json

    OK

    Hide response attributes Show response attributes object
  • 401 application/json

    Your access token is invalid or has expired

    Hide response attributes Show response attributes object
  • 403 application/json

    You do not have permission to access this data

    Hide response attributes Show response attributes object
  • 429 application/json

    You have made too many requests in a short time

    Hide response attributes Show response attributes object
GET /data/noise/measurements 
curl \
 --request GET 'https://api.mycirrus.cloud/v1/data/noise/measurements?instruments=QT123456&instruments=QT234567&start=2023-01-01T00%3A00%3A00Z&end=2023-01-31T00%3A00%3A00Z'
Response examples (200) 
[
  {
    "values": [
      {
        "name": "LAeq",
        "value": 50.73
      },
      {
        "name": "LCPeak",
        "value": 81.93
      },
      {
        "name": "LAFMax",
        "value": 75.94
      }
    ],
    "endTime": "2023-06-14T23:15:00Z",
    "duration": 900,
    "overload": false,
    "startTime": "2023-06-14T23:00:00Z",
    "instrument": "QT123456"
  }
]
Response examples (401) 
{
  "error": "TokenExpired",
  "description": "Your access token is invalid or has expired. Try refreshing the token."
}
Response examples (403) 
{
  "error": "AccessDenied",
  "description": "You do not have permission to access this data."
}
Response examples (429) 
{
  "error": "TooManyRequests",
  "description": "You have made too many requests in a short time. Please wait before trying again."
}