UptimeResponse data model
The UptimeResponse shape in the Visual Sentinel REST API.
Fields
| Field | Type | Required | Description |
|---|---|---|---|
data | array of object | No | Time-bucketed uptime data points. |
data[].time | string (date-time) | Yes | Start of the bucket (ISO 8601 UTC). |
data[].uptime | number | Yes | Uptime percentage for this bucket (0-100). |
regions | array of string | No | Region codes included in the result set. |
meta | object | No | Query metadata describing how the response was assembled. |
meta.mode | string | No | Whether a preset window or a custom from/to range was used. One of: preset, custom. |
meta.granularity | string | No | Bucket size used for the returned data points. One of: minute, hour, day, week. |
meta.bucketSeconds | integer | No | Duration of each bucket in seconds. |
meta.from | string (date-time) | No | Effective start of the window (ISO 8601 UTC). |
meta.to | string (date-time) | No | Effective end of the window (ISO 8601 UTC). |
meta.clampedFrom | boolean | No | True when the requested from was earlier than the oldest available data and was clamped forward. |
meta.source | string | No | Storage tier the data was read from. One of: raw, daily, mixed. |
Used by
- Get uptime statistics:
GET /api/monitors/{id}/uptime
Generated from the OpenAPI 3.1 specification at https://docs.visualsentinel.com/openapi.json.