Docs

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

Sign in Start free

List report runs

Returns report run status, output details, ranges, formats and pagination.

GET https://app.upfour.io/v1/reports/runs
GET https://app.upfour.io/v1/reports/runs
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 2 top-level fields
FieldTypeDescription
data ReportRun[] · nullable
Each item · 23 fields
FieldTypeDescription
created_at string (date-time)
format string one ofcsvjsonpdfxlsx
id uuid
organization_id uuid
params object · nullable free-form keys The parameters the report was rendered with.
range_from string (date-time)
range_to string (date-time)
report_type string one ofexecutive_summarysummarymonitor_reportmonitorsmonitor_slaslaincident_analyticsincidentsresponse_timeresponse-timedowntime_ledgerdowntime-ledgertrends
status string one ofpendingrunningretryingsucceededfailed
client_id uuid
completed_at string (date-time)
content_hash string
delivery ReportDeliveryStatus Mail delivery of a scheduled run; absent for downloads.
ReportDeliveryStatus · 4 fields
FieldTypeDescription
attempts integer
sent integer
total integer
next_attempt_at string (date-time)
error string Why a run failed or was skipped.
output_bytes integer
output_sha256 string
requested_by uuid
schedule_id uuid
storage_key string
pagination Pagination
Pagination · 5 fields
FieldTypeDescription
cursor string · nullable
has_more boolean
limit integer 1–250
next_cursor string · nullable
prev_cursor string · nullable

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.