Reports
- class ab.api.endpoints.reports.ReportsEndpoint(client)[source]
Report generation (ACPortal API).
- Parameters:
client (HttpClient)
- insurance(*, data)[source]
POST /reports/insurance.
- Parameters:
data (InsuranceReportRequest | dict) – Insurance report payload with date range filters. Accepts an
InsuranceReportRequestinstance or a dict.- Return type:
list[InsuranceReport]
Request model:
InsuranceReportRequestDocs: https://ab-sdk.readthedocs.io/en/latest/api/reports/insurance.html Request model: InsuranceReportRequest Response model: List[InsuranceReport]
- sales(*, data)[source]
POST /reports/sales.
- Parameters:
data (SalesForecastReportRequest | dict) – Sales forecast payload with date range and agent code filters. Accepts a
SalesForecastReportRequestinstance or a dict.- Return type:
list[SalesForecastReport]
Request model:
SalesForecastReportRequestDocs: https://ab-sdk.readthedocs.io/en/latest/api/reports/sales.html Request model: SalesForecastReportRequest Response model: List[SalesForecastReport]
- sales_summary(*, data)[source]
POST /reports/sales/summary.
- Parameters:
data (SalesForecastSummaryRequest | dict) – Sales forecast summary payload with date range filters. Accepts a
SalesForecastSummaryRequestinstance or a dict.- Return type:
SalesForecastSummary
Request model:
SalesForecastSummaryRequestDocs: https://ab-sdk.readthedocs.io/en/latest/api/reports/sales_summary.html Request model: SalesForecastSummaryRequest Response model: SalesForecastSummary
- sales_drilldown(*, data)[source]
POST /reports/salesDrilldown.
- Parameters:
data (Web2LeadRevenueFilter | dict) – Revenue filter payload with date range filters. Accepts a
Web2LeadRevenueFilterinstance or a dict.- Return type:
list[RevenueCustomer]
Request model:
Web2LeadRevenueFilterDocs: https://ab-sdk.readthedocs.io/en/latest/api/reports/sales_drilldown.html Request model: Web2LeadRevenueFilter Response model: List[RevenueCustomer]
- top_revenue_customers(*, data)[source]
POST /reports/topRevenueCustomers.
- Parameters:
data (Web2LeadRevenueFilter | dict) – Revenue filter payload with date range filters. Accepts a
Web2LeadRevenueFilterinstance or a dict.- Return type:
list[RevenueCustomer]
Request model:
Web2LeadRevenueFilterDocs: https://ab-sdk.readthedocs.io/en/latest/api/reports/top_revenue_customers.html Request model: Web2LeadRevenueFilter Response model: List[RevenueCustomer]
- top_revenue_sales_reps(*, data)[source]
POST /reports/topRevenueSalesReps.
- Parameters:
data (Web2LeadRevenueFilter | dict) – Revenue filter payload with date range filters. Accepts a
Web2LeadRevenueFilterinstance or a dict.- Return type:
list[RevenueCustomer]
Request model:
Web2LeadRevenueFilterDocs: https://ab-sdk.readthedocs.io/en/latest/api/reports/top_revenue_sales_reps.html Request model: Web2LeadRevenueFilter Response model: List[RevenueCustomer]
- referred_by(*, data)[source]
POST /reports/referredBy.
- Parameters:
data (ReferredByReportRequest | dict) – Referred-by report payload with date range filters. Accepts a
ReferredByReportRequestinstance or a dict.- Return type:
list[ReferredByReport]
Request model:
ReferredByReportRequestDocs: https://ab-sdk.readthedocs.io/en/latest/api/reports/referred_by.html Request model: ReferredByReportRequest Response model: List[ReferredByReport]
- web2lead(*, data)[source]
POST /reports/web2Lead.
- Parameters:
data (Web2LeadV2RequestModel | dict) – Web2Lead report payload with date range filters. Accepts a
Web2LeadV2RequestModelinstance or a dict.- Return type:
list[Web2LeadReport]
Request model:
Web2LeadV2RequestModelDocs: https://ab-sdk.readthedocs.io/en/latest/api/reports/web2lead.html Request model: Web2LeadV2RequestModel Response model: List[Web2LeadReport]
Per-endpoint reference
Each route-backed method has its own page rendering the HTTP route, the
Python and CLI call signatures, and the request/response model field tables.
This is the page help(api.reports.<method>) links to via its Docs: footer.
These pages are generated by scripts/generate_endpoint_docs.py and kept
current by a CI freshness gate.
Methods
insurance
POST /reports/insurance — Generate insurance report.
Returns: InsuranceReport
report = api.reports.insurance(startDate="2025-01-01", endDate="2025-12-31")
sales
POST /reports/sales — Generate sales forecast report.
Returns: SalesForecastReport
report = api.reports.sales(startDate="2025-01-01", endDate="2025-12-31")
sales_summary
POST /reports/sales/summary — Sales summary.
Returns: SalesForecastSummary
sales_drilldown
POST /reports/salesDrilldown — Sales drilldown by customer/rep.
Returns: list[RevenueCustomer]`
top_revenue_customers
POST /reports/topRevenueCustomers — Top revenue customers.
Returns: list[RevenueCustomer]`
top_revenue_sales_reps
POST /reports/topRevenueSalesReps — Top revenue sales reps.
Returns: list[RevenueCustomer]`
referred_by
POST /reports/referredBy — Referral source report.
Returns: ReferredByReport
web2lead
POST /reports/web2Lead — Web lead report.
Returns: Web2LeadReport