Fetch frequency bands measurements

GET /data/frequency/measurements

Get noise frequency band measurements for the selected instruments and time range.

Optionally choose which bands and weighting to use and what period to recalculate results to.

The possible options are:

Band
- Octave - Includes all octave bands from 31.5Hz to 16KHz
- Third - Includes all third octave bands from 6.3Hz to 20KHz
Frequency Weighting
- A
- C
- Z

If you specify an invalid or unavailable band or weighting, the server will respond with an error.
If no band or weighting are specified, the server will return the default results (Octave Z).

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.
bands string

Choose which set of frequency bands to use

Values are Octave or Third. Default value is Octave.
weighting string

Choose which frequency weighting to apply to the results

Values are A, C, or Z. Default value is Z.

Responses

200 application/json

OK
Hide response attributes Show response attributes object
- startTime string(date-time)
- endTime string(date-time)
- duration integer
- instrument string
- overload boolean
- values array[object]
  
  Hide values attributes Show values attributes object
  
  name string
  
  value number
401 application/json

Your access token is invalid or has expired
Hide response attributes Show response attributes object
- error string
  
  Error code
- description string
  
  Description of the error
403 application/json

You do not have permission to access this data
Hide response attributes Show response attributes object
- error string
  
  Error code
- description string
  
  Description of the error
429 application/json

You have made too many requests in a short time
Hide response attributes Show response attributes object
- error string
  
  Error code
- description string
  
  Description of the error

GET /data/frequency/measurements

curl \
 --request GET 'https://api.mycirrus.cloud/v1/data/frequency/measurements?instruments=QT123456&instruments=QT234567&start=2023-01-01T00%3A00%3A00Z&end=2023-01-31T00%3A00%3A00Z'

Response examples (200)

[
  {
    "values": [
      {
        "name": "31.5Hz",
        "value": 50.73
      },
      {
        "name": "63Hz",
        "value": 56.86
      },
      {
        "name": "125Hz",
        "value": 63.46
      },
      "..."
    ],
    "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."
}