Docs

Type a word or a question. Esc closes the search.

Sign in Start free

Get the agency ribbon

Returns client lanes with check totals, monitor counts, uptime percentages and the selected time window.

GET https://app.upfour.io/v1/reports/agency-ribbon
GET https://app.upfour.io/v1/reports/agency-ribbon
Authorization
AuthorizationA pls_ key. It stays in this browser tab. Needs report.read.

Sent directly from your browser to https://app.upfour.io/v1. Mutating calls get an automatic Idempotency-Key when the field is empty.

Request
Responsenot sent yet
Fill in a key and press Send request (⌘↵).
The answer appears here.
scope report.read stable returns 200

Returns

A successful request returns 200 with application/json.

Response fields 1 top-level fields
FieldTypeDescription
data ReportAgencyRibbon
ReportAgencyRibbon · 15 fields
FieldTypeDescription
clients ReportRibbonLane[] · nullable
Each item · 11 fields
FieldTypeDescription
checks_total integer
id uuid
monitors integer
name string
segments ReportRibbonSegment[] · nullable
Each item · 4 fields
FieldTypeDescription
end string (date-time)
start string (date-time)
state string one ofdowndegraded
monitor_name string
uptime_pct number · nullable null when the window holds no checks.
kind string one ofcompanyclient
window string one of6h24h7d30d
window_end string (date-time)
window_start string (date-time)

Errors

Only the errors this operation can return. Every error uses the same envelope.

Status Code Meaning
400 bad_request The request is malformed or fails validation.
403 permission_denied The credentials do not permit this action.

Every call can also return unauthorized (401), rate_limit_exceeded (429) or internal_error (500 / 502). See Responses and errors.