Sign in
Reports

Create Report

Create a new report for the current customer. Requires admin authentication.

post/admin/reports

Request body

namestring required

Report name

report_type'leads_summary' | 'inquiries_summary' required

Report type enum for Pydantic schemas

frequency'daily' | 'weekly' required

Report frequency enum for Pydantic schemas

send_timestring

Time of day to send the report (HH:MM:SS)

emailsstring[]

List of email addresses

user_idsstring[]

List of user IDs to receive the report

staff_group_idsstring[]

List of staff group IDs to receive the report

leads_summary_include_qualifiedboolean

Include qualified leads in leads summary report

leads_summary_include_partially_qualifiedboolean

Include partially qualified leads in leads summary report

leads_summary_include_no_matched_caseboolean

Include no matched case leads in leads summary report

Response

Successful Response

idstring required

Report ID

namestring required

Report name

messagestring required

Success message

Changes