Get a list of events

GET /data/events

Get a list of events for the selected instruments and time range.

The maximum date range per request is 31 days. If you request a longer range, the server will respond with an error.

Requires an API key with the data.events: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.

Responses

200 application/json

OK
Hide response attributes Show response attributes object
- type string
- name string
- level integer
- startTime string(date-time)
- endTime string(date-time)
- audioTime string | null
- instrument string
- overall array[number]
- octave array[number]
- thirdOctave array[number]
- timeHistoryId string
  
  ID of the time history data for this event. Used to download the time history data.
- audioId string
  
  ID of the audio data for this event. Used to download the audio data.
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/events

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

Response examples (200)

[
  {
    "name": "LAeq",
    "type": "Noise",
    "level": 65,
    "octave": null,
    "audioId": "soqufchwnw8-qkxiwtgqa5-akdicuysja",
    "endTime": "2023-06-16T11:35:40Z",
    "overall": [
      57.67,
      82.53,
      55.4,
      60.5,
      70.1,
      49.93
    ],
    "audioTime": "2023-06-16T11:35:25Z",
    "startTime": "2023-06-16T11:35:20Z",
    "instrument": "QT123456",
    "thirdOctave": null,
    "timeHistoryId": "asliuh-fufks87s-oqkusd7"
  }
]

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."
}