Skip to content

Create report schedule

POST
/api/v1/analytics/report-schedules

Create a new automated report schedule.

Authorizations

Request Body required

Schema for creating a new report schedule.

Attributes: template_name: Schedule name (max 60 chars). frequency: “weekly” or “monthly”. day_of_week: 0=Mon..6=Sun for weekly schedules. day_of_month: 1-28 for monthly schedules. time_utc: HH:MM delivery time (default “08:00”). timezone: IANA timezone (default “UTC”). output_format: “pdf”, “xlsx”, or “csv” (default “pdf”). recipient_emails: Non-empty list of email addresses. is_active: Whether enabled (default True).

object
day_of_month
Any of:
integer
day_of_week
Any of:
integer
frequency
required
string
is_active
boolean
default: true
output_format
string
default: pdf
recipient_emails
required
Array<string>
template_name
required
string
<= 60 characters
time_utc
string
default: 08:00
timezone
string
default: UTC

Responses

201

Successful Response

object
key
additional properties
any

422

Validation Error

object
detail
Array<object>
object
ctx
object
input
loc
required
Array
msg
required
string
type
required
string