RetrieveAccountStats

AccountService / RetrieveAccountStats

Description: Retrieve account stats

URL: http://{your-server-url}/api/v1/core/accounts/stats

Method: GET

Token Required: True

Request Headers:

content-type: application/json or content-type: application/xml
token: {token}

Required Roles:

Portal Administrator, Account Administrator, Account Owner

Rights:

Type: Nexus.AppSpace.Service.Contract.Model.Enums.Rights.Rights

Right	Require	Comment
Portal_Management	Optional	Optional but need to have at least one
Account_Management	Optional
Account_Owner	Optional

Request Query Parameters:

Parameter	Type	Nullable	Description
page	int	True	page number
accountids	int[]	True	comma separated values, eg. accountids=1,2,3
statuses	Nexus.AppSpace.Service.Contract.Model.Enums.Account.Status[]	True	comma separated values, eg. statuses=active,disabled,pending_activation,deleted
rpp	int	True	records per page, default = 50, max = 500

Example: http://{your-server-url}/api/v1/core/accounts/stats?page=100&accountids=1,2,3&rpp=100

Response:

Type: Nexus.AppSpace.Service.Contract.Messages.AppSpaceIntegration.v1.Account.AccountResponse

Parameter	Type
Response.AccountStats	Nexus.AppSpace.Service.Contract.Model.DTO.AppSpaceIntegration.v1.Stats.AccountStat[]
Response.TotalAccount	int
Response.ActiveAccountCount	int
Response.DisabledAccountCount	int
Response.PendingAccountCount	int
Response.DeletedAccountCount	int

Enums:

Field	Name	Values
Status	Nexus.AppSpace.Service.Contract.Model.Enums.Account.Status	Undefined = 0, Active = 1, Disabled = 2, Pending_Activation = 3, Deleted = 4

The following is an example response Xml body:

<AccountResponse xmlns="http://schemas.datacontract.org/2004/07/Nexus.AppSpace.Service.Contract.Messages.AppSpaceIntegration.v1.Account" xmlns:i="http://www.w3.org/2001/XMLSchema-instance">
  <DebugMessage xmlns="http://schemas.datacontract.org/2004/07/Nexus.AppSpace.Service.Contract.Messages">String</DebugMessage>
  <Errors xmlns="http://schemas.datacontract.org/2004/07/Nexus.AppSpace.Service.Contract.Messages">
    <Error>
      <Code>String</Code>
      <Message>String</Message>
      <StackTrace>String</StackTrace>
    </Error>
  </Errors>
  <Status xmlns="http://schemas.datacontract.org/2004/07/Nexus.AppSpace.Service.Contract.Messages">Success</Status>
  <AccountStats xmlns:a="http://schemas.datacontract.org/2004/07/Nexus.AppSpace.Service.Contract.Model.DTO.AppSpaceIntegration.v1.Stats">
    <a:AccountStat>
      <a:ActiveContentStat>
        <a:AccountId>123</a:AccountId>
        <a:ContentCount>123</a:ContentCount>
        <a:ContentType>HTML_Text</a:ContentType>
        <a:TotalContentSize>0</a:TotalContentSize>
      </a:ActiveContentStat>
      <a:ApplicationCount>123</a:ApplicationCount>
      <a:CommunicationLostDeviceCount>123</a:CommunicationLostDeviceCount>
      <a:DatasourceCount>123</a:DatasourceCount>
      <a:DeletedContentStat>
        <a:AccountId>123</a:AccountId>
        <a:ContentCount>123</a:ContentCount>
        <a:ContentType>HTML_Text</a:ContentType>
        <a:TotalContentSize>0</a:TotalContentSize>
      </a:DeletedContentStat>
      <a:FailedDeviceCount>123</a:FailedDeviceCount>
      <a:Id>123</a:Id>
      <a:MediaZoneCount>123</a:MediaZoneCount>
      <a:OfflineDeviceCount>123</a:OfflineDeviceCount>
      <a:OnlineDeviceCount>123</a:OnlineDeviceCount>
      <a:Status>Deleted</a:Status>
      <a:TotalDevice>123</a:TotalDevice>
      <a:WidgetCount>123</a:WidgetCount>
    </a:AccountStat>
  </AccountStats>
  <ActiveAccountCount>123</ActiveAccountCount>
  <DeletedAccountCount>123</DeletedAccountCount>
  <DisabledAccountCount>123</DisabledAccountCount>
  <PendingAccountCount>123</PendingAccountCount>
  <TotalAccount>123</TotalAccount>
</AccountResponse>

The following is an example response Json body:

{
	"DebugMessage":"String",
	"Errors":[
		{
			"Code":"String",
			"Message":"String",
			"StackTrace":"String"
		}
	],
	"Status":1,
	"AccountStats":[
		{
			"ActiveContentStat":{
				"AccountId":123,
				"ContentCount":123,
				"ContentType":17,
				"TotalContentSize":0
			},
			"ApplicationCount":123,
			"CommunicationLostDeviceCount":123,
			"DatasourceCount":123,
			"DeletedContentStat":{
				"AccountId":123,
				"ContentCount":123,
				"ContentType":17,
				"TotalContentSize":0
			},
			"FailedDeviceCount":123,
			"Id":123,
			"MediaZoneCount":123,
			"OfflineDeviceCount":123,
			"OnlineDeviceCount":123,
			"Status":4,
			"TotalDevice":123,
			"WidgetCount":123
		}
	],
	"ActiveAccountCount":123,
	"DeletedAccountCount":123,
	"DisabledAccountCount":123,
	"PendingAccountCount":123,
	"TotalAccount":123
}