latestOpenAPI 3.1.02026-08-21724493743.3 KB

2a1adc380310

reports

Create Schedule

post/api/reports/schedules

Request body

type'executive' | 'campaign' | 'agent_performance' | 'conversation' | 'lead' | 'cost_roi' | 'knowledge_base' | 'compliance' | 'summarizer_brief' required
format'pdf' | 'xlsx' | 'csv' | 'docx' | 'png' required
namestring required
frequency'daily' | 'weekly' | 'monthly' required
hourIstinteger
dayOfWeekinteger nullable
dayOfMonthinteger nullable
recipientsstring[]
startDatestring nullable
endDatestring nullable
agentIdstring nullable
useCaseIdstring nullable
sourcestring nullable

Response

Successful Response

{"stackTrail":"paths:/api/reports/schedules:post:responses:200:content:application/json:schema","oasType":"schema","type":"unknown"}