Skip to content
UltimateTeam.ai Docs

Create report schedule

POST
/api/v1/analytics/report-schedules
curl --request POST \
  --url https://api.ultimateteam.ai/api/v1/analytics/report-schedules \
  --header 'Content-Type: application/json' \
  --header 'X-API-Key: <X-API-Key>' \
  --data '{ "day_of_month": 1, "day_of_week": 1, "frequency": "example", "is_active": true, "output_format": "pdf", "recipient_emails": [ "example" ], "template_name": "example", "time_utc": "08:00", "timezone": "UTC" }'

Create a new automated report schedule.

Authorizations

Section titled “Authorizations”

Request Bodyrequired

Section titled “Request Bodyrequired”
Media typeapplication/json
ReportScheduleCreate

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
Frequency
string
is_active
Is Active
boolean
default: true
output_format
Output Format
string
default: pdf
recipient_emails
required
Recipient Emails
Array<string>
template_name
required
Template Name
string
<= 60 characters
time_utc
Time Utc
string
default: 08:00
timezone
Timezone
string
default: UTC

Responses

Section titled “ Responses ”

201

Section titled “201”

Successful Response

Media typeapplication/json
Response Create Report Schedule Api V1 Analytics Report Schedules Post
object
key
additional properties
any
Examplegenerated
{}

422

Section titled “422”

Validation Error

Media typeapplication/json
HTTPValidationError
object
detail
Detail
Array<object>
ValidationError
object
ctx
Context
object
input
Input
loc
required
Location
Array
msg
required
Message
string
type
required
Error Type
string
Examplegenerated
{
  "detail": [
    {
      "ctx": {},
      "input": "example",
      "loc": [
        "example"
      ],
      "msg": "example",
      "type": "example"
    }
  ]
}