GET api/web/analytics/{month}/{year}

Gets analytic data from Conservice.

Request Information

Body Parameters

None.

Response Information

The analytic data

NameDescriptionTypeAdditional information
Response

Response message detailing request result.

Response

None.

AnalyticsData

Collection of cost usage data and property detail

Collection of AnalyticData

None.

Response Formats

application/json, text/json

Sample:
{
  "Response": {
    "ActionSuccess": true,
    "Message": "sample string 2"
  },
  "AnalyticsData": [
    {
      "Community": "sample string 1",
      "Units": 2,
      "UnitsOnEBill": 3,
      "PropertiesOnEBill": 4,
      "TotalBillsSent": 5,
      "TotalEBillsSent": 6,
      "ExternalPropertyNumber": "sample string 7"
    },
    {
      "Community": "sample string 1",
      "Units": 2,
      "UnitsOnEBill": 3,
      "PropertiesOnEBill": 4,
      "TotalBillsSent": 5,
      "TotalEBillsSent": 6,
      "ExternalPropertyNumber": "sample string 7"
    }
  ]
}

application/xml, text/xml

Sample:
<AnalyticsDataResponse xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/GreystarAnalytics.BOL">
  <AnalyticsData>
    <AnalyticData>
      <Community>sample string 1</Community>
      <ExternalPropertyNumber>sample string 7</ExternalPropertyNumber>
      <PropertiesOnEBill>4</PropertiesOnEBill>
      <TotalBillsSent>5</TotalBillsSent>
      <TotalEBillsSent>6</TotalEBillsSent>
      <Units>2</Units>
      <UnitsOnEBill>3</UnitsOnEBill>
    </AnalyticData>
    <AnalyticData>
      <Community>sample string 1</Community>
      <ExternalPropertyNumber>sample string 7</ExternalPropertyNumber>
      <PropertiesOnEBill>4</PropertiesOnEBill>
      <TotalBillsSent>5</TotalBillsSent>
      <TotalEBillsSent>6</TotalEBillsSent>
      <Units>2</Units>
      <UnitsOnEBill>3</UnitsOnEBill>
    </AnalyticData>
  </AnalyticsData>
  <Response>
    <ActionSuccess>true</ActionSuccess>
    <Message>sample string 2</Message>
  </Response>
</AnalyticsDataResponse>