Run a report schedule now

Starts a report run immediately and returns its status, output details and delivery state.

POST https://app.upfour.io/v1/reports/schedules/{scheduleID}/run-now

A real request. Sending it changes data in your up4 account.

Authorization

AuthorizationA pls_ key. It stays in this browser tab. Needs report.write.

Path

scheduleIDpath · requiredPart of the request path.

Headers

Idempotency-KeyheaderGenerated automatically when empty. How it works

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.write stable Idempotency-Key supported returns 202

Parameters

Field	Type	Description
`scheduleID` required	uuid	path parameter

Returns

A successful request returns 202 with application/json.

Response fields 1 top-level fields

Field Type Description

data ReportRun

ReportRun · 23 fields

Field Type Description

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

Field	Type	Description
`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

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.
402	`billing_action_unavailable`	The Company's billing state does not allow this action. When: A metered or limited action while the billing state, such as paused or without credit, blocks it; details holds the action and billing_state. Fix: Top up the credit or change the plan, then retry.
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.
503	`quota_gate_unavailable`	The limit check itself failed, so the action was not carried out. When: The quota service could not decide while the request ran. Fix: Retry in a moment; nothing was changed.
403 / 429	`quota_limit_reached`	A usage or inventory limit of the Company was reached. When: Counters and concurrency limits answer 429 with Retry-After, inventory and capacity limits answer 403; details holds purpose, limit and window. Fix: On 429 wait Retry-After seconds; on 403 free something up, request a higher limit where details.raise_request is true, or buy an extension.
503	`service_unavailable`	The service or a required dependency is temporarily unavailable.

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

const res = await fetch("https://app.upfour.io/v1/reports/schedules/00000000-0000-4000-8000-000000000001/run-now", { method: "POST", headers: { Authorization: `Bearer ${process.env.UP4_API_KEY}`, }, }); console.log(res.status, await res.json());

import os import requests res = requests.post( "https://app.upfour.io/v1/reports/schedules/00000000-0000-4000-8000-000000000001/run-now", headers={"Authorization": f"Bearer {os.environ['UP4_API_KEY']}"}, ) print(res.status_code, res.json())

package main import ( "fmt" "io" "net/http" "os" ) func main() { req, _ := http.NewRequest("POST", "https://app.upfour.io/v1/reports/schedules/00000000-0000-4000-8000-000000000001/run-now", nil) req.Header.Set("Authorization", "Bearer "+os.Getenv("UP4_API_KEY")) res, err := http.DefaultClient.Do(req) if err != nil { panic(err) } defer res.Body.Close() out, _ := io.ReadAll(res.Body) fmt.Println(res.StatusCode, string(out)) }

<?php $ch = curl_init("https://app.upfour.io/v1/reports/schedules/00000000-0000-4000-8000-000000000001/run-now"); curl_setopt_array($ch, [ CURLOPT_CUSTOMREQUEST => "POST", CURLOPT_RETURNTRANSFER => true, CURLOPT_HTTPHEADER => [ "Authorization: Bearer " . getenv("UP4_API_KEY"), ], ]); $response = curl_exec($ch); echo curl_getinfo($ch, CURLINFO_RESPONSE_CODE), " ", $response, "\n"; curl_close($ch);

{ "data": { "content_hash": "3c8dc35de8b20338c83d488ff7e387f6ff1542a8747f8aa45665c4bacefe149a", "created_at": "2026-10-27T09:00:00Z", "delivery": { "attempts": 1, "next_attempt_at": "2026-10-27T09:00:00Z", "sent": 0, "total": 1 }, "error": "1 recipient(s) could not be reached: anna@example.com: email delivery is not configured", "format": "pdf", "id": "00000000-0000-4000-8000-000000000002", "organization_id": "00000000-0000-4000-8000-000000000003", "output_bytes": 18432, "output_sha256": "721378bc96ef2ddece4a66b447ba60d6a1266860d9cb23f4e0e6c152f30279cb", "params": { "from": "2026-10-20T09:00:00Z", "lang": "en", "preset": "7d", "scope": { "HideCompanyLevel": false, "ID": "00000000-0000-4000-8000-000000000004", "Mode": 1, "TeamVisibleClientIDs": null }, "timezone": "Europe/Berlin", "to": "2026-10-27T09:00:00Z" }, "range_from": "2026-10-20T09:00:00Z", "range_to": "2026-10-27T09:00:00Z", "report_type": "summary", "requested_by": "00000000-0000-4000-8000-000000000005", "schedule_id": "00000000-0000-4000-8000-000000000001", "status": "retrying", "storage_key": "example/reports/v1/00000000-0000-4000-8000-000000000003/00000000-0000-4000-8000-000000000002.pdf" } }