api.reports.web2lead

POST /reports/web2Lead — ACPortal

Python

api.reports.web2lead(*, data: Web2LeadV2RequestModel | dict) -> list[Web2LeadReport]

CLI

ab reports web2lead [--data ...]

POST /reports/web2Lead.

Args: data: Web2Lead report payload with date range filters. Accepts a :class:Web2LeadV2RequestModel instance or a dict.

Request model: :class:Web2LeadV2RequestModel

Request body — Web2LeadV2RequestModel

Field	Type	Required	Description
startDate	Optional[str]	no	Range start date (ISO 8601)
endDate	Optional[str]	no	Range end date (ISO 8601)
pageNo	Optional[int]	no	Page number
pageSize	Optional[int]	no	Items per page
sortBy	Optional[dict]	no	Sort config {sortByField: int, sortDir: bool}

Response

Returns a list of List[Web2LeadReport].

Field	Type	Required	Description
franchiseeID	Optional[str]	no	Franchisee ID
type	Optional[str]	no	Lead type
jobDisplayID	Optional[str]	no	Job display ID
intacctStatus	Optional[str]	no	Intacct status
leadDate	Optional[str]	no	Lead creation date
companyName	Optional[str]	no	Company name
referPage	Optional[str]	no	Referring page URL
entryURL	Optional[str]	no	Entry URL
submissionPage	Optional[str]	no	Submission page URL
howHeard	Optional[str]	no	How customer heard of us
email	Optional[str]	no	Contact email
phone	Optional[str]	no	Contact phone
shipFrom	Optional[str]	no	Ship from location
shipTo	Optional[str]	no	Ship to location
referredName	Optional[str]	no	Referral name
customerComments	Optional[str]	no	Customer comments
currentBookPrice	Optional[float]	no	Current booked price
currentBookProfit	Optional[float]	no	Current booked profit
referredByCategory	Optional[str]	no	Referral category
totalRecords	Optional[int]	no	Total record count

---

← Back to api.reports