GET api/users/me/account/statistics

This method will retrieve account usage statistics for a user account

Requires Authorization!

Request Information

URI Parameters

None.

Body Parameters

None.

Response Information

Resource Description

Instance of

UsageStatistics

Name	Type	Additional information
ClientCount	integer	None.
PropertyCount	integer	None.
TownshipCount	integer	None.
CountyCount	integer	None.
ReportCount	integer	None.
AppealCount	integer	None.
MonthlyUsage	Collection of MonthlyUserUsageStatistics	None.
AppealCounts	UserAppealCounts	None.

Response Formats

application/json, text/json

Sample:

{
  "clientCount": 1,
  "propertyCount": 2,
  "townshipCount": 3,
  "countyCount": 4,
  "reportCount": 5,
  "appealCount": 6,
  "monthlyUsage": [
    {
      "month": 1,
      "year": 2,
      "propertyAnalyzedCount": 3,
      "documentGeneratedCount": 4,
      "clientAddedCount": 5,
      "propertyAddedCount": 6,
      "appealsAnalyzedCount": 7,
      "numberOfAppealPurchasedMonthly": 8,
      "numberOfRolloverAppeals": 9
    },
    {
      "month": 1,
      "year": 2,
      "propertyAnalyzedCount": 3,
      "documentGeneratedCount": 4,
      "clientAddedCount": 5,
      "propertyAddedCount": 6,
      "appealsAnalyzedCount": 7,
      "numberOfAppealPurchasedMonthly": 8,
      "numberOfRolloverAppeals": 9
    }
  ],
  "appealCounts": {
    "subscriptionMonthlyAppealCount": 1,
    "purchasedMonthlyAppealCounty": 2,
    "rolloverAppealCount": 3,
    "generatedMonthlyAppealCount": 4,
    "availableMonthlyAppealCount": 5
  }
}

text/html

Sample:

{"clientCount":1,"propertyCount":2,"townshipCount":3,"countyCount":4,"reportCount":5,"appealCount":6,"monthlyUsage":[{"month":1,"year":2,"propertyAnalyzedCount":3,"documentGeneratedCount":4,"clientAddedCount":5,"propertyAddedCount":6,"appealsAnalyzedCount":7,"numberOfAppealPurchasedMonthly":8,"numberOfRolloverAppeals":9},{"month":1,"year":2,"propertyAnalyzedCount":3,"documentGeneratedCount":4,"clientAddedCount":5,"propertyAddedCount":6,"appealsAnalyzedCount":7,"numberOfAppealPurchasedMonthly":8,"numberOfRolloverAppeals":9}],"appealCounts":{"subscriptionMonthlyAppealCount":1,"purchasedMonthlyAppealCounty":2,"rolloverAppealCount":3,"generatedMonthlyAppealCount":4,"availableMonthlyAppealCount":5}}

application/xml, text/xml

Sample:

<UsageStatistics xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Ptd.Model.Pos">
  <AppealCount>6</AppealCount>
  <AppealCounts>
    <AvailableMonthlyAppealCount>5</AvailableMonthlyAppealCount>
    <GeneratedMonthlyAppealCount>4</GeneratedMonthlyAppealCount>
    <PurchasedMonthlyAppealCounty>2</PurchasedMonthlyAppealCounty>
    <RolloverAppealCount>3</RolloverAppealCount>
    <SubscriptionMonthlyAppealCount>1</SubscriptionMonthlyAppealCount>
  </AppealCounts>
  <ClientCount>1</ClientCount>
  <CountyCount>4</CountyCount>
  <MonthlyUsage>
    <MonthlyUserUsageStatistics>
      <AppealsAnalyzedCount>7</AppealsAnalyzedCount>
      <ClientAddedCount>5</ClientAddedCount>
      <DocumentGeneratedCount>4</DocumentGeneratedCount>
      <Month>1</Month>
      <NumberOfAppealPurchasedMonthly>8</NumberOfAppealPurchasedMonthly>
      <NumberOfRolloverAppeals>9</NumberOfRolloverAppeals>
      <PropertyAddedCount>6</PropertyAddedCount>
      <PropertyAnalyzedCount>3</PropertyAnalyzedCount>
      <Year>2</Year>
    </MonthlyUserUsageStatistics>
    <MonthlyUserUsageStatistics>
      <AppealsAnalyzedCount>7</AppealsAnalyzedCount>
      <ClientAddedCount>5</ClientAddedCount>
      <DocumentGeneratedCount>4</DocumentGeneratedCount>
      <Month>1</Month>
      <NumberOfAppealPurchasedMonthly>8</NumberOfAppealPurchasedMonthly>
      <NumberOfRolloverAppeals>9</NumberOfRolloverAppeals>
      <PropertyAddedCount>6</PropertyAddedCount>
      <PropertyAnalyzedCount>3</PropertyAnalyzedCount>
      <Year>2</Year>
    </MonthlyUserUsageStatistics>
  </MonthlyUsage>
  <PropertyCount>2</PropertyCount>
  <ReportCount>5</ReportCount>
  <TownshipCount>3</TownshipCount>
</UsageStatistics>