Fetch vibration data

GET /data/vibration/{type}

Get ground vibration measurements for the selected instruments and time range. Either Peak Particle Velocity (PPV) or Vibration Dose Value (VDV) based on the type parameter.

Optionally choose what period to recalculate results to.

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 1 minute.
The period can be set to anything between 1 minute 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.enviro:read scope.

Path parameters

  • type string Required

    The type of data to return (PPV or VDV)

    Values are PPV or VDV.

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 data samples to.

    This cannot be less than the recorded data period.

    This uses the ISO8601 duration format. For example, P1D is 1 day, PT1H is 1 hour, PT1M is 1 minute.

Responses

  • 200 application/json

    OK

    One of:
    array-1 array[object] array-2 array[object]

    List of PPV results

    Hide attributes Show attributes object
    • startTime string(date-time)

      Time of the sample

    • duration integer

      Duration of the sample in seconds

    • instrument string

      Instrument serial number

    • vMaxX number | null

      Peak particle velocity (PPV) in X direction in mm/s

    • vMaxY number | null

      Peak particle velocity (PPV) in Y direction in mm/s

    • vMaxZ number | null

      Peak particle velocity (PPV) in Z direction in mm/s

    • fDomX number | null

      Dominant frequency in X direction in Hz

    • fDomY number | null

      Dominant frequency in Y direction in Hz

    • fDomZ number | null

      Dominant frequency in Z direction in Hz
  • 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
  • 429 application/json

    You have made too many requests in a short time

    Hide response attributes Show response attributes object
GET /data/vibration/{type} 
curl \
 --request GET 'https://api.mycirrus.cloud/v1/data/vibration/{type}?instruments=QT123456&instruments=QT234567&start=2023-01-01T00%3A00%3A00Z&end=2023-01-31T00%3A00%3A00Z'
Response examples (200) 
[
  {
    "fDomX": 5,
    "fDomY": null,
    "fDomZ": 13.5,
    "vMaxX": 0.6442,
    "vMaxY": null,
    "vMaxZ": 0.3546,
    "duration": 60,
    "startTime": "2023-07-07T03:19:00Z",
    "instrument": "AABBCC"
  }
]
[
  {
    "vdvX": 0.0008,
    "vdvY": 0.0006,
    "vdvZ": 0.0022,
    "duration": 60,
    "startTime": "2023-07-06T23:00:00Z",
    "instrument": "FODFGO"
  }
]
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."
}