Get event audio recording

GET /data/events/audio/{id}

Get the audio recording for the given noise event.

Requires an API key with the data.events:read and data.audio:read scopes.

Path parameters

  • id string Required

    ID of the audio for this event

Query parameters

  • format string

    Choose audio file format and codec

    Values are FLAC, WAV, AAC, or OGG. Default value is FLAC.

Responses

  • 200 application/octet-stream

    OK

    The audio data encoded in the format specified in the request

  • 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
  • 404 application/json

    There is an error in the request, possibly missing parameter or incorrect url.

    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/events/audio/{id}
curl \
 --request GET 'https://api.mycirrus.cloud/v1/data/events/audio/{id}'
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 (404)
{
  "error": "MissingParam",
  "description": "The required parameter StartTime was missing from the request."
}
{
  "error": "NotFound",
  "description": "The instrument QT123456 could not be found."
}
Response examples (429)
{
  "error": "TooManyRequests",
  "description": "You have made too many requests in a short time. Please wait before trying again."
}