Get monitoring history

Uptime and latency series for a customer’s targets over 24h, 7d or 30d, optionally for one region or target.

Deprecated aliases: GET https://one.vigilbase.com/api/customers/{id}/monitoring/history. They answer with the same bodies, with a Deprecation header and a successor-version link to this URL.

GET/customers/{customerId}/monitoring/history

Authorizations

Send one of these:

AuthorizationstringAccess tokenheaderrequired

Bearer access token from Vigilbase Identity (auth.vigilbase.com), sent as Authorization: Bearer <token>. The CLI gets one with vigilbase login. Scope: one:api.

AuthorizationstringAPI keyheaderrequired

Organisation API key (vb_one_…) from Settings → API keys in Vigilbase One, sent as Authorization: Bearer vb_one_…. Read-only keys work. See organisation API keys.

AuthorizationstringMCP tokenheaderrequired

Vigilbase Identity access token issued to an MCP client (mcp.vigilbase.com). Scope: one:read.

Permissions checkedread:monitoring

Path Parameters

customerIdstringuuidrequired

Query Parameters

rangestring

One of:24h7d30dDefault:"7d"

regionstring

Probe region code, e.g. nyc, lon, sgp.

min length 2max length 16

targetIdstringuuid

Response

application/json

Success

rangestringrequired

One of:24h7d30d

targetIdanyrequired

regionstring | nullrequired

aggregatedUptimeobject[]required

Uptime percentage, 0–100.

2 child attributes

timestampintegerrequired

Epoch milliseconds.

minimum -9007199254740991maximum 9007199254740991

valuenumber | nullrequired

aggregatedLatencyobject[]required

Latency in milliseconds.

2 child attributes

timestampintegerrequired

Epoch milliseconds.

minimum -9007199254740991maximum 9007199254740991

valuenumber | nullrequired

regionLatencyobjectrequired

regionsstring[]required

targetsobject[]required

Per-target series for the first five targets with data.

4 child attributes

targetIdstringuuidrequired

uptimeobject[]required

2 child attributes

timestampintegerrequired

Epoch milliseconds.

minimum -9007199254740991maximum 9007199254740991

valuenumber | nullrequired

latencyobject[]required

2 child attributes

timestampintegerrequired

Epoch milliseconds.

minimum -9007199254740991maximum 9007199254740991

valuenumber | nullrequired

regionLatencyobjectrequired

targetsMetaobject[]required

3 child attributes

idstringuuidrequired

domainstringrequired

displayNamestring | nullrequired

dataSourcestringrequired

hasDatabooleanrequired

partialbooleanrequired

True when some per-target series are missing.

2 response headers

X-Request-Idstring

The request ID: yours when it was well-formed, otherwise a new one. Quote it to support.

API-Versionstring

The major API version (informational; the version is in the path).

More about this endpoint in the guide.

# Token from `vigilbase login`, or an API key (vb_one_…)
curl --request GET \
  --url 'https://api.vigilbase.com/one/v1/customers/{customerId}/monitoring/history' \
  --header "Authorization: Bearer $VIGILBASE_TOKEN"

Set VIGILBASE_TOKEN to an Identity access token or an organisation API key first, or use Try it.

{
  "range": "24h",
  "targetId": "<any>",
  "region": "<string>",
  "aggregatedUptime": [
    {
      "timestamp": 123,
      "value": 123
    }
  ],
  "aggregatedLatency": [
    {
      "timestamp": 123,
      "value": 123
    }
  ],
  "regionLatency": {},
  "regions": [
    "<string>"
  ],
  "targets": [
    {
      "targetId": "<uuid>",
      "uptime": [
        {
          "timestamp": 123,
          "value": 123
        }
      ],
      "latency": [
        {
          "timestamp": 123,
          "value": 123
        }
      ],
      "regionLatency": {}
    }
  ],
  "targetsMeta": [
    {
      "id": "<uuid>",
      "domain": "<string>",
      "displayName": "<string>"
    }
  ],
  "dataSource": "<string>",
  "hasData": true,
  "partial": true
}

Was this page helpful?