GET api/users/me/web/webrequests?periodStart={periodStart}&periodEnd={periodEnd}
This method will retrieve all web user visitors and their tax analysis requests for a requested attorney
Requires Authorization!
Request Information
URI Parameters
| Name | Description | Type | Additional information |
|---|---|---|---|
| periodStart |
Period start date [Format:MM/dd/yyyy] |
date |
Required |
| periodEnd |
Period end date [Format:MM/dd/yyyy] |
date |
Required |
Body Parameters
None.
Response Information
Resource Description
Collection of
Collection of WebVisitorResponseModel| Name | Description | Type | Additional information |
|---|---|---|---|
| Id | integer |
None. |
|
| UserId | integer |
None. |
|
| RequestType | string |
None. |
|
| AddressLine1 | string |
None. |
|
| City | string |
None. |
|
| State | string |
None. |
|
| ZipCode | string |
None. |
|
| Township | string |
None. |
|
| County | string |
None. |
|
| PropertyStyle | string |
None. |
|
| PropertyType | string |
None. |
|
| IsVacant | boolean |
None. |
|
| VacancyInformation | string |
None. |
|
| IsMultiPinProperty | boolean |
None. |
|
| MasterPin | string |
None. |
|
| SecondaryPins | string |
None. |
|
| NumberOfStories | string |
None. |
|
| IsRental | boolean |
None. |
|
| IsPrimaryBusinessLocation | boolean |
None. |
|
| BuildingArea | decimal number |
None. |
|
| IsRecentPurchase | boolean |
None. |
|
| PurchasePrice | decimal number |
None. |
|
| IsForeclosureOrShortsale | boolean |
None. |
|
| OwnerFullName | string |
None. |
|
| OwnerEmail | string |
None. |
|
| LegalEntityName | string |
None. |
|
| IsTrust | boolean |
None. |
|
| IsSenior | boolean |
None. |
|
| IsPrimaryResidence | boolean |
None. |
|
| IsLowIncome | boolean |
None. |
|
| PriorLawFirm | string |
None. |
|
| AdditionalInformation | string |
None. |
|
| EngagementDocumentsViewedFlag | boolean |
None. |
|
| EngagementDocumentsViewedDate | date |
None. |
|
| AppealPurchasedFlag | boolean |
None. |
|
| AmountCharged | decimal number |
None. |
|
| PaymentDate | date |
None. |
|
| PaymentMethod | string |
None. |
|
| PaymentSummary | string |
None. |
|
| PaymentReceiptUrl | string |
None. |
|
| PaymentGatewayCustomerId | string |
None. |
|
| PaymentGatewayResponse | string |
None. |
|
| AddedDate | date |
None. |
|
| PropertyAddressId | integer |
None. |
|
| Status | string |
None. |
|
| ProjectedAppealSavingsMaxAmountYear1 | decimal number |
None. |
|
| ProjectedAppealSavingsMinAmountYear1 | decimal number |
None. |
|
| ProjectedAppealSavingsMaxAmountYear2 | decimal number |
None. |
|
| ProjectedAppealSavingsMinAmountYear2 | decimal number |
None. |
|
| ProjectedAppealSavingsMaxAmountYear3 | decimal number |
None. |
|
| ProjectedAppealSavingsMinAmountYear3 | decimal number |
None. |
|
| AnalysisReportUrl | string |
None. |
|
| AnalysisRecommendation | string |
None. |
|
| Notes | string |
None. |
|
| UserPropertyId | integer |
None. |
|
| PropertyPictureUrl | string |
None. |
|
| OwnerPhoneNumber | string |
None. |
Response Formats
application/json, text/json
Sample:
[
{
"id": 1,
"userId": 2,
"requestType": "sample string 3",
"addressLine1": "sample string 4",
"city": "sample string 5",
"state": "sample string 6",
"zipCode": "sample string 7",
"township": "sample string 8",
"county": "sample string 9",
"propertyStyle": "sample string 10",
"propertyType": "sample string 11",
"isVacant": true,
"vacancyInformation": "sample string 13",
"isMultiPinProperty": true,
"masterPin": "sample string 15",
"secondaryPins": "sample string 16",
"numberOfStories": "sample string 17",
"isRental": true,
"isPrimaryBusinessLocation": true,
"buildingArea": 20.1,
"isRecentPurchase": true,
"purchasePrice": 1.0,
"isForeclosureOrShortsale": true,
"ownerFullName": "sample string 23",
"ownerEmail": "sample string 24",
"legalEntityName": "sample string 25",
"isTrust": true,
"isSenior": true,
"isPrimaryResidence": true,
"isLowIncome": true,
"priorLawFirm": "sample string 30",
"additionalInformation": "sample string 31",
"engagementDocumentsViewedFlag": true,
"engagementDocumentsViewedDate": "2025-11-01T08:50:30.7651055-05:00",
"appealPurchasedFlag": true,
"amountCharged": 1.0,
"paymentDate": "2025-11-01T08:50:30.7651055-05:00",
"paymentMethod": "sample string 34",
"paymentSummary": "sample string 35",
"paymentReceiptUrl": "sample string 36",
"paymentGatewayCustomerId": "sample string 37",
"paymentGatewayResponse": "sample string 38",
"addedDate": "2025-11-01T08:50:30.767136-05:00",
"propertyAddressId": 1,
"status": "sample string 39",
"projectedAppealSavingsMaxAmountYear1": 1.0,
"projectedAppealSavingsMinAmountYear1": 1.0,
"projectedAppealSavingsMaxAmountYear2": 1.0,
"projectedAppealSavingsMinAmountYear2": 1.0,
"projectedAppealSavingsMaxAmountYear3": 1.0,
"projectedAppealSavingsMinAmountYear3": 1.0,
"analysisReportUrl": "sample string 40",
"analysisRecommendation": "sample string 41",
"notes": "sample string 42",
"userPropertyId": 1,
"propertyPictureUrl": "sample string 43",
"ownerPhoneNumber": "sample string 44"
},
{
"id": 1,
"userId": 2,
"requestType": "sample string 3",
"addressLine1": "sample string 4",
"city": "sample string 5",
"state": "sample string 6",
"zipCode": "sample string 7",
"township": "sample string 8",
"county": "sample string 9",
"propertyStyle": "sample string 10",
"propertyType": "sample string 11",
"isVacant": true,
"vacancyInformation": "sample string 13",
"isMultiPinProperty": true,
"masterPin": "sample string 15",
"secondaryPins": "sample string 16",
"numberOfStories": "sample string 17",
"isRental": true,
"isPrimaryBusinessLocation": true,
"buildingArea": 20.1,
"isRecentPurchase": true,
"purchasePrice": 1.0,
"isForeclosureOrShortsale": true,
"ownerFullName": "sample string 23",
"ownerEmail": "sample string 24",
"legalEntityName": "sample string 25",
"isTrust": true,
"isSenior": true,
"isPrimaryResidence": true,
"isLowIncome": true,
"priorLawFirm": "sample string 30",
"additionalInformation": "sample string 31",
"engagementDocumentsViewedFlag": true,
"engagementDocumentsViewedDate": "2025-11-01T08:50:30.7651055-05:00",
"appealPurchasedFlag": true,
"amountCharged": 1.0,
"paymentDate": "2025-11-01T08:50:30.7651055-05:00",
"paymentMethod": "sample string 34",
"paymentSummary": "sample string 35",
"paymentReceiptUrl": "sample string 36",
"paymentGatewayCustomerId": "sample string 37",
"paymentGatewayResponse": "sample string 38",
"addedDate": "2025-11-01T08:50:30.767136-05:00",
"propertyAddressId": 1,
"status": "sample string 39",
"projectedAppealSavingsMaxAmountYear1": 1.0,
"projectedAppealSavingsMinAmountYear1": 1.0,
"projectedAppealSavingsMaxAmountYear2": 1.0,
"projectedAppealSavingsMinAmountYear2": 1.0,
"projectedAppealSavingsMaxAmountYear3": 1.0,
"projectedAppealSavingsMinAmountYear3": 1.0,
"analysisReportUrl": "sample string 40",
"analysisRecommendation": "sample string 41",
"notes": "sample string 42",
"userPropertyId": 1,
"propertyPictureUrl": "sample string 43",
"ownerPhoneNumber": "sample string 44"
}
]
text/html
Sample:
[{"id":1,"userId":2,"requestType":"sample string 3","addressLine1":"sample string 4","city":"sample string 5","state":"sample string 6","zipCode":"sample string 7","township":"sample string 8","county":"sample string 9","propertyStyle":"sample string 10","propertyType":"sample string 11","isVacant":true,"vacancyInformation":"sample string 13","isMultiPinProperty":true,"masterPin":"sample string 15","secondaryPins":"sample string 16","numberOfStories":"sample string 17","isRental":true,"isPrimaryBusinessLocation":true,"buildingArea":20.1,"isRecentPurchase":true,"purchasePrice":1.0,"isForeclosureOrShortsale":true,"ownerFullName":"sample string 23","ownerEmail":"sample string 24","legalEntityName":"sample string 25","isTrust":true,"isSenior":true,"isPrimaryResidence":true,"isLowIncome":true,"priorLawFirm":"sample string 30","additionalInformation":"sample string 31","engagementDocumentsViewedFlag":true,"engagementDocumentsViewedDate":"2025-11-01T08:50:30.7651055-05:00","appealPurchasedFlag":true,"amountCharged":1.0,"paymentDate":"2025-11-01T08:50:30.7651055-05:00","paymentMethod":"sample string 34","paymentSummary":"sample string 35","paymentReceiptUrl":"sample string 36","paymentGatewayCustomerId":"sample string 37","paymentGatewayResponse":"sample string 38","addedDate":"2025-11-01T08:50:30.767136-05:00","propertyAddressId":1,"status":"sample string 39","projectedAppealSavingsMaxAmountYear1":1.0,"projectedAppealSavingsMinAmountYear1":1.0,"projectedAppealSavingsMaxAmountYear2":1.0,"projectedAppealSavingsMinAmountYear2":1.0,"projectedAppealSavingsMaxAmountYear3":1.0,"projectedAppealSavingsMinAmountYear3":1.0,"analysisReportUrl":"sample string 40","analysisRecommendation":"sample string 41","notes":"sample string 42","userPropertyId":1,"propertyPictureUrl":"sample string 43","ownerPhoneNumber":"sample string 44"},{"id":1,"userId":2,"requestType":"sample string 3","addressLine1":"sample string 4","city":"sample string 5","state":"sample string 6","zipCode":"sample string 7","township":"sample string 8","county":"sample string 9","propertyStyle":"sample string 10","propertyType":"sample string 11","isVacant":true,"vacancyInformation":"sample string 13","isMultiPinProperty":true,"masterPin":"sample string 15","secondaryPins":"sample string 16","numberOfStories":"sample string 17","isRental":true,"isPrimaryBusinessLocation":true,"buildingArea":20.1,"isRecentPurchase":true,"purchasePrice":1.0,"isForeclosureOrShortsale":true,"ownerFullName":"sample string 23","ownerEmail":"sample string 24","legalEntityName":"sample string 25","isTrust":true,"isSenior":true,"isPrimaryResidence":true,"isLowIncome":true,"priorLawFirm":"sample string 30","additionalInformation":"sample string 31","engagementDocumentsViewedFlag":true,"engagementDocumentsViewedDate":"2025-11-01T08:50:30.7651055-05:00","appealPurchasedFlag":true,"amountCharged":1.0,"paymentDate":"2025-11-01T08:50:30.7651055-05:00","paymentMethod":"sample string 34","paymentSummary":"sample string 35","paymentReceiptUrl":"sample string 36","paymentGatewayCustomerId":"sample string 37","paymentGatewayResponse":"sample string 38","addedDate":"2025-11-01T08:50:30.767136-05:00","propertyAddressId":1,"status":"sample string 39","projectedAppealSavingsMaxAmountYear1":1.0,"projectedAppealSavingsMinAmountYear1":1.0,"projectedAppealSavingsMaxAmountYear2":1.0,"projectedAppealSavingsMinAmountYear2":1.0,"projectedAppealSavingsMaxAmountYear3":1.0,"projectedAppealSavingsMinAmountYear3":1.0,"analysisReportUrl":"sample string 40","analysisRecommendation":"sample string 41","notes":"sample string 42","userPropertyId":1,"propertyPictureUrl":"sample string 43","ownerPhoneNumber":"sample string 44"}]
application/xml, text/xml
Sample:
<ArrayOfWebVisitorResponseModel xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Ptd.Model.WebModels.WebIntegration">
<WebVisitorResponseModel>
<AddedDate>2025-11-01T08:50:30.767136-05:00</AddedDate>
<AdditionalInformation>sample string 31</AdditionalInformation>
<AddressLine1>sample string 4</AddressLine1>
<AmountCharged>1</AmountCharged>
<AnalysisRecommendation>sample string 41</AnalysisRecommendation>
<AnalysisReportUrl>sample string 40</AnalysisReportUrl>
<AppealPurchasedFlag>true</AppealPurchasedFlag>
<BuildingArea>20.1</BuildingArea>
<City>sample string 5</City>
<County>sample string 9</County>
<EngagementDocumentsViewedDate>2025-11-01T08:50:30.7651055-05:00</EngagementDocumentsViewedDate>
<EngagementDocumentsViewedFlag>true</EngagementDocumentsViewedFlag>
<Id>1</Id>
<IsForeclosureOrShortsale>true</IsForeclosureOrShortsale>
<IsLowIncome>true</IsLowIncome>
<IsMultiPinProperty>true</IsMultiPinProperty>
<IsPrimaryBusinessLocation>true</IsPrimaryBusinessLocation>
<IsPrimaryResidence>true</IsPrimaryResidence>
<IsRecentPurchase>true</IsRecentPurchase>
<IsRental>true</IsRental>
<IsSenior>true</IsSenior>
<IsTrust>true</IsTrust>
<IsVacant>true</IsVacant>
<LegalEntityName>sample string 25</LegalEntityName>
<MasterPin>sample string 15</MasterPin>
<Notes>sample string 42</Notes>
<NumberOfStories>sample string 17</NumberOfStories>
<OwnerEmail>sample string 24</OwnerEmail>
<OwnerFullName>sample string 23</OwnerFullName>
<OwnerPhoneNumber>sample string 44</OwnerPhoneNumber>
<PaymentDate>2025-11-01T08:50:30.7651055-05:00</PaymentDate>
<PaymentGatewayCustomerId>sample string 37</PaymentGatewayCustomerId>
<PaymentGatewayResponse>sample string 38</PaymentGatewayResponse>
<PaymentMethod>sample string 34</PaymentMethod>
<PaymentReceiptUrl>sample string 36</PaymentReceiptUrl>
<PaymentSummary>sample string 35</PaymentSummary>
<PriorLawFirm>sample string 30</PriorLawFirm>
<ProjectedAppealSavingsMaxAmountYear1>1</ProjectedAppealSavingsMaxAmountYear1>
<ProjectedAppealSavingsMaxAmountYear2>1</ProjectedAppealSavingsMaxAmountYear2>
<ProjectedAppealSavingsMaxAmountYear3>1</ProjectedAppealSavingsMaxAmountYear3>
<ProjectedAppealSavingsMinAmountYear1>1</ProjectedAppealSavingsMinAmountYear1>
<ProjectedAppealSavingsMinAmountYear2>1</ProjectedAppealSavingsMinAmountYear2>
<ProjectedAppealSavingsMinAmountYear3>1</ProjectedAppealSavingsMinAmountYear3>
<PropertyAddressId>1</PropertyAddressId>
<PropertyPictureUrl>sample string 43</PropertyPictureUrl>
<PropertyStyle>sample string 10</PropertyStyle>
<PropertyType>sample string 11</PropertyType>
<PurchasePrice>1</PurchasePrice>
<RequestType>sample string 3</RequestType>
<SecondaryPins>sample string 16</SecondaryPins>
<State>sample string 6</State>
<Status>sample string 39</Status>
<Township>sample string 8</Township>
<UserId>2</UserId>
<UserPropertyId>1</UserPropertyId>
<VacancyInformation>sample string 13</VacancyInformation>
<ZipCode>sample string 7</ZipCode>
</WebVisitorResponseModel>
<WebVisitorResponseModel>
<AddedDate>2025-11-01T08:50:30.767136-05:00</AddedDate>
<AdditionalInformation>sample string 31</AdditionalInformation>
<AddressLine1>sample string 4</AddressLine1>
<AmountCharged>1</AmountCharged>
<AnalysisRecommendation>sample string 41</AnalysisRecommendation>
<AnalysisReportUrl>sample string 40</AnalysisReportUrl>
<AppealPurchasedFlag>true</AppealPurchasedFlag>
<BuildingArea>20.1</BuildingArea>
<City>sample string 5</City>
<County>sample string 9</County>
<EngagementDocumentsViewedDate>2025-11-01T08:50:30.7651055-05:00</EngagementDocumentsViewedDate>
<EngagementDocumentsViewedFlag>true</EngagementDocumentsViewedFlag>
<Id>1</Id>
<IsForeclosureOrShortsale>true</IsForeclosureOrShortsale>
<IsLowIncome>true</IsLowIncome>
<IsMultiPinProperty>true</IsMultiPinProperty>
<IsPrimaryBusinessLocation>true</IsPrimaryBusinessLocation>
<IsPrimaryResidence>true</IsPrimaryResidence>
<IsRecentPurchase>true</IsRecentPurchase>
<IsRental>true</IsRental>
<IsSenior>true</IsSenior>
<IsTrust>true</IsTrust>
<IsVacant>true</IsVacant>
<LegalEntityName>sample string 25</LegalEntityName>
<MasterPin>sample string 15</MasterPin>
<Notes>sample string 42</Notes>
<NumberOfStories>sample string 17</NumberOfStories>
<OwnerEmail>sample string 24</OwnerEmail>
<OwnerFullName>sample string 23</OwnerFullName>
<OwnerPhoneNumber>sample string 44</OwnerPhoneNumber>
<PaymentDate>2025-11-01T08:50:30.7651055-05:00</PaymentDate>
<PaymentGatewayCustomerId>sample string 37</PaymentGatewayCustomerId>
<PaymentGatewayResponse>sample string 38</PaymentGatewayResponse>
<PaymentMethod>sample string 34</PaymentMethod>
<PaymentReceiptUrl>sample string 36</PaymentReceiptUrl>
<PaymentSummary>sample string 35</PaymentSummary>
<PriorLawFirm>sample string 30</PriorLawFirm>
<ProjectedAppealSavingsMaxAmountYear1>1</ProjectedAppealSavingsMaxAmountYear1>
<ProjectedAppealSavingsMaxAmountYear2>1</ProjectedAppealSavingsMaxAmountYear2>
<ProjectedAppealSavingsMaxAmountYear3>1</ProjectedAppealSavingsMaxAmountYear3>
<ProjectedAppealSavingsMinAmountYear1>1</ProjectedAppealSavingsMinAmountYear1>
<ProjectedAppealSavingsMinAmountYear2>1</ProjectedAppealSavingsMinAmountYear2>
<ProjectedAppealSavingsMinAmountYear3>1</ProjectedAppealSavingsMinAmountYear3>
<PropertyAddressId>1</PropertyAddressId>
<PropertyPictureUrl>sample string 43</PropertyPictureUrl>
<PropertyStyle>sample string 10</PropertyStyle>
<PropertyType>sample string 11</PropertyType>
<PurchasePrice>1</PurchasePrice>
<RequestType>sample string 3</RequestType>
<SecondaryPins>sample string 16</SecondaryPins>
<State>sample string 6</State>
<Status>sample string 39</Status>
<Township>sample string 8</Township>
<UserId>2</UserId>
<UserPropertyId>1</UserPropertyId>
<VacancyInformation>sample string 13</VacancyInformation>
<ZipCode>sample string 7</ZipCode>
</WebVisitorResponseModel>
</ArrayOfWebVisitorResponseModel>