Skip to content
UltimateTeam.ai Docs

Create a report template

POST
/api/v1/reports/templates

Create a new custom report template scoped to the caller’s tenant. Metric IDs are validated against the catalog.

Authorizations

Request Body required

Schema for creating a new report template.

Attributes: name: Template name (max 120 chars). description: Optional description. metric_ids: Non-empty list of metric_id strings. filters: Optional dict of filter key-value pairs. groupings: Optional list of grouping columns. schedule: Optional cron expression. output_format: One of json, pdf, csv. delivery_email: Optional email for delivery. shared_with_tenant: Whether to share with all tenant users.

object
delivery_email
Any of:
string
description
Any of:
string
filters
object
key
additional properties
any
groupings
Array<string>
metric_ids
required
Array<string>
name
required
string
<= 120 characters
output_format
string
default: json
schedule
Any of:
string
shared_with_tenant
boolean

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