# Run a report schedule now — API reference > Starts a report run immediately and returns its status, output details and delivery state. Source: https://upfour.io/docs/api/reports/run-a-report-schedule-now [Developers](https://upfour.io/docs/api.md)/[Reports](https://upfour.io/docs/api/reports.md) 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 scope report.write stable [Idempotency-Key supported](https://upfour.io/docs/api/idempotency.md) 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 FieldTypeDescription `created_at` string (date-time) `format` string one of`csv` `json` `pdf` `xlsx` `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 of`executive_summary` `summary` `monitor_report` `monitors` `monitor_sla` `sla` `incident_analytics` `incidents` `response_time` `response-time` `downtime_ledger` `downtime-ledger` `trends` `status` string one of`pending` `running` `retrying` `succeeded` `failed` `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 | | | ## Errors Only the errors this operation can return. Every error uses the [same envelope](https://upfour.io/docs/api/responses.md). | Status | Code | Meaning | | --- | --- | --- | | 400 | [bad_request](https://upfour.io/docs/api/errors#code-bad_request) | The request is malformed or fails validation. | | 402 | [billing_action_unavailable](https://upfour.io/docs/api/errors#code-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](https://upfour.io/docs/api/errors#code-not_found) | The requested resource does not exist or is outside the caller's scope. | | 403 | [permission_denied](https://upfour.io/docs/api/errors#code-permission_denied) | The credentials do not permit this action. | | 503 | [quota_gate_unavailable](https://upfour.io/docs/api/errors#code-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](https://upfour.io/docs/api/errors#code-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](https://upfour.io/docs/api/errors#code-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](https://upfour.io/docs/api/responses.md). [PreviousDelete a report schedule](https://upfour.io/docs/api/reports/delete-a-report-schedule.md) [NextList report runs](https://upfour.io/docs/api/reports/list-report-runs.md) ## Request ### cURL ```bash curl -s -X POST "https://app.upfour.io/v1/reports/schedules/00000000-0000-4000-8000-000000000001/run-now" \ -H "Authorization: Bearer $UP4_API_KEY" ``` ### JavaScript ```javascript 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()); ``` ### Python ```python 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()) ``` ### Go ```go 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 ```php "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); ``` ## Response ### 202 ```json { "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" } } ``` ### 400 ```json { "error": { "code": "bad_request", "message": "The request is malformed or fails validation.", "request_id": "req_…" } } ``` ### 402 ```json { "error": { "code": "billing_action_unavailable", "message": "The Company's billing state does not allow this action.", "request_id": "req_…" } } ``` ### 403 ```json { "error": { "code": "permission_denied", "message": "The credentials do not permit this action.", "request_id": "req_…" } } ``` ### 404 ```json { "error": { "code": "not_found", "message": "The requested resource does not exist or is outside the caller's scope.", "request_id": "req_…" } } ``` ### 429 ```json { "error": { "code": "quota_limit_reached", "message": "A usage or inventory limit of the Company was reached.", "request_id": "req_…" } } ``` ### 503 ```json { "error": { "code": "quota_gate_unavailable", "message": "The limit check itself failed, so the action was not carried out.", "request_id": "req_…" } } ```