Fetch frequency bands time history

GET /data/frequency/timehistory

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

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

The maximum date range per request is 1 day. If you request a longer range, the server will respond with an error.
The default Period is 1 second.
The period can be set to anything between the current time history setting and 1 minute. If you request a period outside this range, the server will respond with an error.
You can request data with a period of less than 1 second by using a fractional seconds value in the period. For example, PT0.1S for 100ms.

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 time history samples to.

This cannot be less than the recorded time history period.

This uses the ISO8601 duration format. For example, PT1H is 1 hour, PT1M is 1 minute, PT1S is 1 second.
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
- instrument string
- type string
- blocks array[object]
  
  Block of frequency time history bands and values
  
  Hide blocks attributes Show blocks attributes object
  
  start string(date-time)
  
  end string(date-time)
  
  sampleDuration number
  
  values array[object]
  
  Hide values attributes Show values attributes object
  
  band string
  
  values array[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/timehistory

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

Response examples (200)

[
  {
    "type": "Octave",
    "blocks": [
      {
        "end": "2019-08-24T14:30:00Z",
        "bands": [
          {
            "name": "31.5Hz",
            "values": [
              55.3,
              43.1,
              45.6,
              "..."
            ]
          },
          "..."
        ],
        "start": "2019-08-24T14:15:00Z",
        "sampleDuration": 1000
      },
      "..."
    ],
    "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."
}