Fetch system monitor statistics

GET /data/monitor/stats

Get system monitor stats for the selected instruments and time range.

Only supported by Quantum noise monitors.

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.system: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
- time string(date-time)
  
  Time of the sample
- instrument string
  
  Instrument serial number
- samplePeriod integer
  
  Sample period in seconds
- cpu number
  
  CPU usage as a percentage
- mem number
  
  Memory usage in megabytes
- cache number
  
  Memory cache usage in megabytes
- temp number
  
  SoC Temperature in degrees Celsius
- voltage number
  
  Input voltage in volts
- disk number
  
  Disk usage in megabytes
- netRx number
  
  Network usage (receive), total in kilobits
- netTx number
  
  Network usage (transmit), total in kilobits
- mTot number
  
  Total memory size in megabytes
- dTot number
  
  Total disk space in megabytes
- lteRsrp number | null
  
  LTE signal strength
- lteRsrq number | null
  
  LTE signal quality
- lteSinr number | null
  
  LTE signal to noise ratio
- lteSignal number | null
  
  LTE signal quality
- ping number
  
  Ping time in milliseconds
- network number
  
  Network usage, kilobits per second
- memoryPercent number
  
  Memory usage as a percentage
- diskPercent number
  
  Disk usage as a percentage
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/monitor/stats

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

Response examples (200)

[
  {
    "cpu": 13.9,
    "mem": 285.8,
    "dTot": 24892,
    "disk": 56.7,
    "mTot": 3793,
    "ping": 0,
    "temp": 36,
    "time": "2023-06-15T23:01:00Z",
    "cache": 531.4,
    "netRx": 492,
    "netTx": 119,
    "lteRsrp": null,
    "lteRsrq": null,
    "lteSinr": null,
    "network": 10.18333333333333,
    "voltage": 11.671,
    "lteSignal": null,
    "diskPercent": 0.2277840269966254,
    "samplePeriod": 60,
    "memoryPercent": 7.534932770893751
  }
]

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