Fetch a list of audio recordings

GET /data/audio

Get a list of all audio recordings for this instrumetn and time range

Requires an API key with the data.audio: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
- id string
- instrument string
- startTime string(date-time)
- endTime string(date-time)
- triggerStartTime string(date-time)
- triggerEndTime string(date-time)
- triggerName string
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/audio

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

Response examples (200)

[
  {
    "id": "3uCLgmZuV1ITGOLOBTzgDm8d9SMX52AixUtpSfEELGYsUQMmZw",
    "endTime": "2023-06-12T10:28:00",
    "startTime": "2023-06-12T10:27:41",
    "instrument": "QT123456",
    "triggerName": "Default",
    "triggerEndTime": "2023-06-12T10:27:55Z",
    "triggerStartTime": "2023-06-12T10:27:42Z"
  }
]

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