GET v1/PropertyStatistics/{Id}?MinimumDate={MinimumDate}&MaximumDate={MaximumDate}&TimeCreatedInGMT={TimeCreatedInGMT}&SecurityHash={SecurityHash}&BrandId={BrandId}
Get method for retrieving the statistics
Request Information
URI Parameters
Name | Description | Type | Additional information |
---|---|---|---|
id |
The brand's listing id |
integer |
None. |
minimumDate |
optional minimum date parameter; when not set, assumes through beginning of time /// |
date |
None. |
maximumDate |
optional maximum date parameter; when not set, assumes through end of today /// |
date |
None. |
timeCreatedInGMT |
Time Created in GMT in seconds since January 1, 1970 |
string |
None. |
securityHash |
Security hash for checking purposes |
string |
None. |
brandId |
Your brand identifier |
integer |
None. |
Body Parameters
None.
Response Information
Resource Description
PropertyStatisticsResponseName | Description | Type | Additional information |
---|---|---|---|
propertyId |
LaF property id |
integer |
None. |
minimumDate |
Minimum date used |
date |
None. |
maximumDate |
Maximum date used |
date |
None. |
summaries |
The list of summaries requested |
Collection of StatisticsSummaryViewModel |
None. |
success |
indicates the call was successful or not |
boolean |
None. |
errors |
array of error messages |
Collection of string |
None. |
Response Formats
application/json, text/json
Sample:
{ "propertyId": 1, "minimumDate": "2023-05-30T06:29:54.0943686-07:00", "maximumDate": "2023-05-30T06:29:54.0943686-07:00", "summaries": [ { "pageViews": 1, "searchViews": 2, "sellerEmailCount": 3, "referralEmailCount": 4, "dateOfSummary": "0007-06-01T00:00:00", "month": 6, "year": 7, "frontPageViews": 8, "externalUrlViews": 9, "sellerViewPhoneViews": 10, "landingPageViews": 11 }, { "pageViews": 1, "searchViews": 2, "sellerEmailCount": 3, "referralEmailCount": 4, "dateOfSummary": "0007-06-01T00:00:00", "month": 6, "year": 7, "frontPageViews": 8, "externalUrlViews": 9, "sellerViewPhoneViews": 10, "landingPageViews": 11 } ], "success": true, "errors": [ "sample string 1", "sample string 2" ] }
application/xml, text/xml
Sample:
<PropertyStatisticsResponse xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/LandAndFarmWebApi.Models.Statistics"> <errors xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays" xmlns="http://schemas.datacontract.org/2004/07/LandAndFarmWebApi.Response"> <d2p1:string>sample string 1</d2p1:string> <d2p1:string>sample string 2</d2p1:string> </errors> <success xmlns="http://schemas.datacontract.org/2004/07/LandAndFarmWebApi.Response">true</success> <maximumDate>2023-05-30T06:29:54.0943686-07:00</maximumDate> <minimumDate>2023-05-30T06:29:54.0943686-07:00</minimumDate> <propertyId>1</propertyId> <summaries> <StatisticsSummaryViewModel> <dateOfSummary>0007-06-01T00:00:00</dateOfSummary> <externalUrlViews>9</externalUrlViews> <frontPageViews>8</frontPageViews> <landingPageViews>11</landingPageViews> <month>6</month> <pageViews>1</pageViews> <referralEmailCount>4</referralEmailCount> <searchViews>2</searchViews> <sellerEmailCount>3</sellerEmailCount> <sellerViewPhoneViews>10</sellerViewPhoneViews> <year>7</year> </StatisticsSummaryViewModel> <StatisticsSummaryViewModel> <dateOfSummary>0007-06-01T00:00:00</dateOfSummary> <externalUrlViews>9</externalUrlViews> <frontPageViews>8</frontPageViews> <landingPageViews>11</landingPageViews> <month>6</month> <pageViews>1</pageViews> <referralEmailCount>4</referralEmailCount> <searchViews>2</searchViews> <sellerEmailCount>3</sellerEmailCount> <sellerViewPhoneViews>10</sellerViewPhoneViews> <year>7</year> </StatisticsSummaryViewModel> </summaries> </PropertyStatisticsResponse>