System Status Records¶
Reference for the system_status_records endpoints of the Surfmeter API.
Surfmeter API – System Status Records v1¶
The Surfmeter API lets you manage clients, users, capabilities, measurements, and organization-wide settings programmatically.
Servers¶
| Description | URL |
|---|---|
| https://surfmeter-server.{host}/client_admin_api/v1 | https://surfmeter-server.{host}/client_admin_api/v1 |
System Status Records¶
GET /clients/{id}/system_status_records¶
Input parameters
| Parameter | In | Type | Default | Nullable | Description |
|---|---|---|---|---|---|
ApiKeyAuth |
header | string | N/A | No | API key used on every request. Create keys in the Surfmeter Dashboard under Keys → Surfmeter API Keys. |
id |
path | string | No |
Response 200 OK
{
"system_status_records": [
{
"id": 0,
"run_id": "string",
"client_uuid": "string",
"started_at": "2026-01-15T10:30:00Z",
"finished_at": "2026-01-15T10:30:00Z",
"created_at": "2026-01-15T10:30:00Z",
"platform": "string",
"runtime_scope": "string",
"sample_interval_seconds": 0,
"study_ids": [
"string"
],
"measurement_ids": [
0
],
"connection_detail_trace_id": 0,
"connection_details": [
{
"id": 0,
"type": "string",
"client_time": "2026-01-15T10:30:00Z",
"ip_address": "string",
"subnet": "string",
"ssid": "string",
"bssid": "string",
"rssi": 10.12,
"signal_strength": 10.12,
"channel": 10.12,
"frequency": 10.12,
"link_speed": 10.12,
"link_speed_rx": 10.12,
"link_speed_tx": 10.12
}
],
"cpu_valid_sample_count": 0,
"cpu_average_percent": 10.12,
"cpu_max_percent": 10.12,
"cpu_final_percent": 10.12,
"memory_valid_sample_count": 0,
"memory_effective_total_bytes": 0,
"memory_average_percent": 10.12,
"memory_max_percent": 10.12,
"memory_final_percent": 10.12,
"collection_errors": [
"string"
],
"filesystems": [
{
"device": "string",
"mount": "string",
"type": "string",
"writable": true,
"total_bytes": 0,
"valid_sample_count": 0,
"average_percent": 10.12,
"maximum_percent": 10.12,
"final_percent": 10.12,
"minimum_available_bytes": 0,
"final_available_bytes": 0
}
]
}
]
}
Schema of the response body
{
"type": "object",
"required": [
"system_status_records"
],
"properties": {
"system_status_records": {
"type": "array",
"items": {
"type": "object",
"required": [
"id",
"run_id",
"study_ids",
"measurement_ids",
"filesystems",
"connection_details",
"collection_errors",
"created_at"
],
"properties": {
"id": {
"type": "integer"
},
"run_id": {
"type": "string"
},
"client_uuid": {
"type": "string"
},
"started_at": {
"type": "string",
"format": "date-time",
"nullable": true,
"example": "2026-01-15T10:30:00Z"
},
"finished_at": {
"type": "string",
"format": "date-time",
"nullable": true,
"example": "2026-01-15T10:30:00Z"
},
"created_at": {
"type": "string",
"format": "date-time",
"example": "2026-01-15T10:30:00Z"
},
"platform": {
"type": "string",
"nullable": true
},
"runtime_scope": {
"type": "string",
"nullable": true
},
"sample_interval_seconds": {
"type": "integer"
},
"study_ids": {
"type": "array",
"items": {
"type": "string"
}
},
"measurement_ids": {
"type": "array",
"items": {
"type": "integer"
}
},
"connection_detail_trace_id": {
"type": "integer",
"nullable": true
},
"connection_details": {
"type": "array",
"items": {
"type": "object",
"properties": {
"id": {
"type": "integer"
},
"type": {
"type": "string"
},
"client_time": {
"type": "string",
"format": "date-time",
"example": "2026-01-15T10:30:00Z"
},
"ip_address": {
"type": "string",
"nullable": true
},
"subnet": {
"type": "string",
"nullable": true
},
"ssid": {
"type": "string",
"nullable": true
},
"bssid": {
"type": "string",
"nullable": true
},
"rssi": {
"type": "number",
"nullable": true
},
"signal_strength": {
"type": "number",
"description": "WiFi signal strength in percent (0–100); the raw value in dBm is in `rssi`",
"nullable": true
},
"channel": {
"type": "number",
"nullable": true
},
"frequency": {
"type": "number",
"nullable": true
},
"link_speed": {
"type": "number",
"nullable": true
},
"link_speed_rx": {
"type": "number",
"nullable": true
},
"link_speed_tx": {
"type": "number",
"nullable": true
}
},
"additionalProperties": true
}
},
"cpu_valid_sample_count": {
"type": "integer"
},
"cpu_average_percent": {
"type": "number",
"nullable": true
},
"cpu_max_percent": {
"type": "number",
"nullable": true
},
"cpu_final_percent": {
"type": "number",
"nullable": true
},
"memory_valid_sample_count": {
"type": "integer"
},
"memory_effective_total_bytes": {
"type": "integer",
"nullable": true
},
"memory_average_percent": {
"type": "number",
"nullable": true
},
"memory_max_percent": {
"type": "number",
"nullable": true
},
"memory_final_percent": {
"type": "number",
"nullable": true
},
"collection_errors": {
"type": "array",
"items": {
"type": "string"
}
},
"filesystems": {
"type": "array",
"items": {
"type": "object",
"required": [
"writable",
"valid_sample_count"
],
"properties": {
"device": {
"type": "string",
"nullable": true
},
"mount": {
"type": "string",
"nullable": true
},
"type": {
"type": "string",
"nullable": true
},
"writable": {
"type": "boolean"
},
"total_bytes": {
"type": "integer",
"nullable": true
},
"valid_sample_count": {
"type": "integer"
},
"average_percent": {
"type": "number",
"nullable": true
},
"maximum_percent": {
"type": "number",
"nullable": true
},
"final_percent": {
"type": "number",
"nullable": true
},
"minimum_available_bytes": {
"type": "integer",
"nullable": true
},
"final_available_bytes": {
"type": "integer",
"nullable": true
}
}
}
}
}
}
}
}
}
Schemas¶
SystemStatusRecordIndexResponse¶
| Name | Type |
|---|---|
system_status_records |
Array<Properties: id, run_id, client_uuid, started_at, finished_at, created_at, platform, runtime_scope, sample_interval_seconds, study_ids, measurement_ids, connection_detail_trace_id, connection_details, cpu_valid_sample_count, cpu_average_percent, cpu_max_percent, cpu_final_percent, memory_valid_sample_count, memory_effective_total_bytes, memory_average_percent, memory_max_percent, memory_final_percent, collection_errors, filesystems> |
Security schemes¶
| Name | Type | Scheme | Description |
|---|---|---|---|
| ApiKeyAuth | apiKey | API key used on every request. Create keys in the Surfmeter Dashboard under Keys → Surfmeter API Keys. |