Reports
The Prism API (port 9003) manages recurring report requests, while the worker executes schedules and delivery —
decide when a report is generated and delivered, and the log of what was sent.
All endpoints authenticate with the standard gck_* / prism_* key
(Authentication) and are scoped to the caller.
Schedules
Section titled “Schedules”A schedule is a report cadence (weekly, daily, or monthly) with a set of sections.
| Method | Path | Purpose |
|---|---|---|
GET | /v1/reports/schedules | List the caller’s schedules |
POST | /v1/reports/schedules | Create a schedule |
POST | /v1/reports/schedules/defaults | Create the default set of schedules (weekly) |
PATCH | /v1/reports/schedules/:id | Update a schedule |
DELETE | /v1/reports/schedules/:id | Delete a schedule |
POST | /v1/reports/schedules/:id/run | Run a schedule immediately (out of cadence) |
Create / update body (fields, all optional on update):
frequency—"weekly","daily", or"monthly".sections— which report sections to include (see section defaults below).
Section defaults
Section titled “Section defaults”| Method | Path | Purpose |
|---|---|---|
GET | /v1/reports/section-defaults?frequency=weekly | The default section list for a given frequency |
Returns { "sections": [...] } — the section keys enabled by default for that
cadence. Use it to seed the sections field when creating a schedule.
Deliveries
Section titled “Deliveries”Every time a schedule fires (or is run on demand), it records a delivery.
| Method | Path | Purpose |
|---|---|---|
GET | /v1/reports/deliveries | List recent deliveries for the caller |
GET | /v1/reports/deliveries/:id | Fetch a single delivery |