# 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.<br>
The default Period is 1 minute.<br>
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.


## Servers
- Production server: https://api.mycirrus.cloud/v1 (Production server)



## Parameters

### Path parameters
- **type** (string)
  The type of data to return (PPV or VDV)

### Query parameters
- **instruments** (array[string])
  Serial numbers of selected instruments
- **start** (string(date-time))
  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))
  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
OK

#### Body: application/json (array[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
Your access token is invalid or has expired

#### Body: application/json (object)
- **error** (string)
  Error code
- **description** (string)
  Description of the error

### 403
You do not have permission to access this data

#### Body: application/json (object)
- **error** (string)
  Error code
- **description** (string)
  Description of the error

### 429
You have made too many requests in a short time

#### Body: application/json (object)
- **error** (string)
  Error code
- **description** (string)
  Description of the error


[Powered by Bump.sh](https://bump.sh)