API reference · Pages & reporting

Reports

Availability and SLA reporting: summaries, trends, exports, schedules, share links.

Base URL https://app.upfour.io/v1 · auth via Authorization: Bearer <key> · “Try it” runs from your browser — the key is kept in this tab only. Use a pls_test_ sandbox key to experiment freely.

GET /reports/agency-ribbon

scope report.read stable returns 200

curl -s https://app.upfour.io/v1/reports/agency-ribbon \
  -H "Authorization: Bearer $UP4_API_KEY"
Try it

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

GET /reports/downtime-ledger

scope report.read stable returns 200

curl -s https://app.upfour.io/v1/reports/downtime-ledger \
  -H "Authorization: Bearer $UP4_API_KEY"
Try it

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

GET /reports/export

scope report.read stable returns 200

curl -s https://app.upfour.io/v1/reports/export \
  -H "Authorization: Bearer $UP4_API_KEY"
Try it

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

GET /reports/incidents

scope report.read stable returns 200

curl -s https://app.upfour.io/v1/reports/incidents \
  -H "Authorization: Bearer $UP4_API_KEY"
Try it

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

GET /reports/monitor-ribbon

scope report.read stable returns 200

curl -s https://app.upfour.io/v1/reports/monitor-ribbon \
  -H "Authorization: Bearer $UP4_API_KEY"
Try it

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

GET /reports/monitors

scope report.read stable returns 200

curl -s https://app.upfour.io/v1/reports/monitors \
  -H "Authorization: Bearer $UP4_API_KEY"
Try it

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

GET /reports/response-time

scope report.read stable returns 200

curl -s https://app.upfour.io/v1/reports/response-time \
  -H "Authorization: Bearer $UP4_API_KEY"
Try it

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

GET /reports/runs

scope report.read stable returns 200

curl -s https://app.upfour.io/v1/reports/runs \
  -H "Authorization: Bearer $UP4_API_KEY"
Try it

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

GET /reports/schedules

scope report.read stable returns 200

curl -s https://app.upfour.io/v1/reports/schedules \
  -H "Authorization: Bearer $UP4_API_KEY"
Try it

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

POST /reports/schedules

scope report.read stable returns 201

curl -s -X POST https://app.upfour.io/v1/reports/schedules \
  -H "Authorization: Bearer $UP4_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{}'
Try it

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

GET /reports/schedules/{scheduleID}

scope report.read stable returns 200

ParameterInTypeNotes
scheduleIDrequired path uuid
curl -s https://app.upfour.io/v1/reports/schedules/<scheduleID> \
  -H "Authorization: Bearer $UP4_API_KEY"
Try it

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

PUT /reports/schedules/{scheduleID}

scope report.read stable returns 200

ParameterInTypeNotes
scheduleIDrequired path uuid
curl -s -X PUT https://app.upfour.io/v1/reports/schedules/<scheduleID> \
  -H "Authorization: Bearer $UP4_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{}'
Try it

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

DELETE /reports/schedules/{scheduleID}

scope report.read stable returns 204

ParameterInTypeNotes
scheduleIDrequired path uuid
curl -s -X DELETE https://app.upfour.io/v1/reports/schedules/<scheduleID> \
  -H "Authorization: Bearer $UP4_API_KEY"
Try it

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

POST /reports/schedules/{scheduleID}/run-now

scope report.read stable returns 201

ParameterInTypeNotes
scheduleIDrequired path uuid
curl -s -X POST https://app.upfour.io/v1/reports/schedules/<scheduleID>/run-now \
  -H "Authorization: Bearer $UP4_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{}'
Try it

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

GET /reports/sla

scope report.read stable returns 200

curl -s https://app.upfour.io/v1/reports/sla \
  -H "Authorization: Bearer $UP4_API_KEY"
Try it

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

GET /reports/summary

scope report.read stable returns 200

curl -s https://app.upfour.io/v1/reports/summary \
  -H "Authorization: Bearer $UP4_API_KEY"
Try it

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

GET /reports/verify/{hash}

scope report.read stable returns 200

ParameterInTypeNotes
hashrequired path uuid
curl -s https://app.upfour.io/v1/reports/verify/<hash> \
  -H "Authorization: Bearer $UP4_API_KEY"
Try it

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

POST /reports/{runID}/share

scope report.read stable returns 201

ParameterInTypeNotes
runIDrequired path uuid
curl -s -X POST https://app.upfour.io/v1/reports/<runID>/share \
  -H "Authorization: Bearer $UP4_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{}'
Try it

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