Observer Docs

GET

metrics

test

{job_id}

Get the result of a probe test that was still running (testProbe returned 202)

curl --request GET \
  --url https://use.observer/api/v1/metrics/test/{job_id} \
  --header 'Authorization: Bearer <token>'

const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};

fetch('https://use.observer/api/v1/metrics/test/{job_id}', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

{
  "value": 123,
  "unit": "<string>",
  "status": "healthy",
  "duration_ms": 123,
  "mode": "agent",
  "value_description": "<string>",
  "reason": "<string>",
  "reason_label": "<string>",
  "reason_hint": "<string>",
  "job_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "agent_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "thresholds_complete": true,
  "skipped_secret_headers": [
    "<string>"
  ]
}

{
  "job_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "status": "pending",
  "poll": "<string>",
  "agent_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "expires_at": "2023-11-07T05:31:56Z",
  "detail": "<string>"
}

{
  "type": "https://docs.use.observer/api/getting-started/errors#forbidden",
  "title": "forbidden",
  "status": 403,
  "detail": "missing scope: write:incidents"
}

{
  "type": "https://docs.use.observer/api/getting-started/errors#forbidden",
  "title": "forbidden",
  "status": 403,
  "detail": "missing scope: write:incidents"
}

{
  "type": "https://docs.use.observer/api/getting-started/errors#forbidden",
  "title": "forbidden",
  "status": 403,
  "detail": "missing scope: write:incidents"
}

{
  "type": "https://docs.use.observer/api/getting-started/errors#forbidden",
  "title": "forbidden",
  "status": 403,
  "detail": "missing scope: write:incidents"
}

{
  "type": "https://docs.use.observer/api/getting-started/errors#forbidden",
  "title": "forbidden",
  "status": 403,
  "detail": "missing scope: write:incidents"
}

{
  "type": "https://docs.use.observer/api/getting-started/errors#forbidden",
  "title": "forbidden",
  "status": 403,
  "detail": "missing scope: write:incidents"
}

{
  "type": "https://docs.use.observer/api/getting-started/errors#forbidden",
  "title": "forbidden",
  "status": 403,
  "detail": "missing scope: write:incidents"
}

Authorizations

Authorization

string

header

required

An organization API key (obs_pub_…) sent as Authorization: Bearer <key>. Each key carries scopes; an endpoint lists the scope it needs. read:change_events is reserved: keys can carry it, but no endpoint needs it yet.

Path Parameters

job_id

string<uuid>

required

job_id from a 202 testProbe response.

Response

the probe ran

value

number | null

required

What the probe measured, in unit. null when it got no value (see reason).

unit

string | null

required

Unit of value (ms, %, days, s, B/s), or null for a bare number. Same rules as a metric's unit.

status

enum<string> | null

required

The status these thresholds give the value; no_data when the probe got no value. null when a value was measured but thresholds were not all given.

Available options:

healthy,

degraded,

unhealthy,

no_data,

null

duration_ms

integer

required

How long the probe took, in milliseconds.

mode

enum<string>

required

agent: ran on the agent's network with its secrets. cloud: a public HTTP check run from Observer's cloud.

Available options:

agent,

cloud

value_description

string | null

What the value is, in words.

reason

string | null

Why there is no value: the agent's reason code (e.g. ETIMEDOUT, unexpected_status:503). null on success.

reason_label

string | null

Short human description of reason.

reason_hint

string | null

What usually causes reason and how to fix it.

job_id

string<uuid> | null

The agent job (agent mode only).

agent_id

string<uuid> | null

thresholds_complete

boolean

skipped_secret_headers

string[]

Cloud mode only: header_refs names that were not sent, because their values live on an agent host.

Get the result of a probe test that was still running (testProbe returned 202)

curl --request GET \
  --url https://use.observer/api/v1/metrics/test/{job_id} \
  --header 'Authorization: Bearer <token>'

const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};

fetch('https://use.observer/api/v1/metrics/test/{job_id}', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

{
  "value": 123,
  "unit": "<string>",
  "status": "healthy",
  "duration_ms": 123,
  "mode": "agent",
  "value_description": "<string>",
  "reason": "<string>",
  "reason_label": "<string>",
  "reason_hint": "<string>",
  "job_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "agent_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "thresholds_complete": true,
  "skipped_secret_headers": [
    "<string>"
  ]
}

{
  "job_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "status": "pending",
  "poll": "<string>",
  "agent_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "expires_at": "2023-11-07T05:31:56Z",
  "detail": "<string>"
}

{
  "type": "https://docs.use.observer/api/getting-started/errors#forbidden",
  "title": "forbidden",
  "status": 403,
  "detail": "missing scope: write:incidents"
}

{
  "type": "https://docs.use.observer/api/getting-started/errors#forbidden",
  "title": "forbidden",
  "status": 403,
  "detail": "missing scope: write:incidents"
}

{
  "type": "https://docs.use.observer/api/getting-started/errors#forbidden",
  "title": "forbidden",
  "status": 403,
  "detail": "missing scope: write:incidents"
}

{
  "type": "https://docs.use.observer/api/getting-started/errors#forbidden",
  "title": "forbidden",
  "status": 403,
  "detail": "missing scope: write:incidents"
}

{
  "type": "https://docs.use.observer/api/getting-started/errors#forbidden",
  "title": "forbidden",
  "status": 403,
  "detail": "missing scope: write:incidents"
}

{
  "type": "https://docs.use.observer/api/getting-started/errors#forbidden",
  "title": "forbidden",
  "status": 403,
  "detail": "missing scope: write:incidents"
}

{
  "type": "https://docs.use.observer/api/getting-started/errors#forbidden",
  "title": "forbidden",
  "status": 403,
  "detail": "missing scope: write:incidents"
}

Getting started

Account

Status pages

Services

Metrics

SLOs

SLA statements

Incidents

Maintenances

Config as code

Agents

Change events

Audit log

Get a probe test result

Authorizations

Path Parameters

Response