Docs

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

Sign in Start free

Get the report summary

Returns check, uptime, downtime, response-time and incident totals.

GET https://app.upfour.io/v1/reports/summary
GET https://app.upfour.io/v1/reports/summary
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 ReportSummary
ReportSummary · 12 fields
FieldTypeDescription
avg_response_evaluated boolean
avg_response_ms number 0 when avg_response_evaluated is false: no check recorded a latency.
evaluated boolean
failed_checks integer
incident_count integer Incidents that started inside the window.
monitor_count integer
mttr_seconds number
open_incidents integer Unresolved incidents right now, the number the dashboard shows; not limited to the window.
resolved_incidents integer
total_checks integer
total_downtime_seconds number
uptime_percentage number Absent when no check ran in the window (evaluated is false).

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.