api.reports.top_revenue_customers

POST /reports/topRevenueCustomers — ACPortal

Python

api.reports.top_revenue_customers(*, data: Web2LeadRevenueFilter | dict) -> list[RevenueCustomer]

CLI

ab reports top_revenue_customers [--data ...]

POST /reports/topRevenueCustomers.

Args: data: Revenue filter payload with date range filters. Accepts a :class:Web2LeadRevenueFilter instance or a dict.

Request model: :class:Web2LeadRevenueFilter

Request body — Web2LeadRevenueFilter

Field	Type	Required	Description
startDate	Optional[str]	no	Range start date (ISO 8601)
endDate	Optional[str]	no	Range end date (ISO 8601)
userID	Optional[str]	no	User/franchisee ID

Response

Returns a list of List[RevenueCustomer].

Field	Type	Required	Description
id	Optional[str]	no	Customer or rep ID
name	Optional[str]	no	Customer or rep name

---

← Back to api.reports