Docs

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

Sign in Start free

Get a report schedule

Returns one report schedule with cadence, recipients, report type, next-run timestamps and frozen parameters.

GET https://app.upfour.io/v1/reports/schedules/{scheduleID}
GET https://app.upfour.io/v1/reports/schedules/{scheduleID}
Authorization
AuthorizationA pls_ key. It stays in this browser tab. Needs report.read.
Path

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

Parameters

FieldTypeDescription
scheduleID required uuid path parameter

Returns

A successful request returns 200 with application/json.

Response fields 1 top-level fields
FieldTypeDescription
data ReportSchedule
ReportSchedule · 21 fields
FieldTypeDescription
cadence string one ofweeklymonthly
created_at string (date-time)
enabled boolean
format string one ofcsvjsonpdfxlsx
id uuid
language string · nullable one ofende null when the schedule inherits.
name string
next_run_at string (date-time)
organization_id uuid
params object · nullable free-form keys The frozen report parameters; see the request.
recipients string[] · nullable
report_type string one ofexecutive_summarysummarymonitor_reportmonitorsmonitor_slaslaincident_analyticsincidentsresponse_timeresponse-timedowntime_ledgerdowntime-ledgertrends
send_hour integer
timezone string
updated_at string (date-time)
client_id uuid
created_by uuid
day_of_month integer
day_of_week integer
effective_language string one ofende The language the schedule renders in now.
last_run_at 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.
404 not_found The requested resource does not exist or is outside the caller's scope.
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.