Accounts-account-email-domain-statistics-mailboxTypeCount:GET

From Hostway API Documentation
Jump to: navigation, search

GET /accounts/{account}/email/{domain}/statistics/mailboxTypeCount

Retrieves per domain statistics about webmail usage

Contents


Request

GET /accounts/{account}/email/{domain}/statistics/mailboxTypeCount

Request Parameters

account - string
The user account owning the domain and the mailboxes
domain - string
The specific domain for which the call will retrieve the list

Response

Status Code

200 OK
Success
401 Unauthorized
The supplied credentials are invalid or do not provide permissions for this operation.
404 Not Found
The domain name or account does not exist.

Response Body

{	
    "numStandard": {numStandard},	
    "numActiveSync": {numActiveSync},	
    "numPremium": {numPremium},
    "numExchange2013Standard": {numExchange2013Standard},
    "numExchange2013Premium": {numExchange2013Premium}
    "links": [
        {
            "href": "{href}",
            "rel": "{rel}"
        }
    ]
}
 

Parameters

numStandard - integer
Number of mailboxes for the domain with standard webmail access
numActiveSync - integer
Number of mailboxes for the domain with activesync webmail access
numPremium - integer
Number of mailboxes for the domain with premium webmail access
numExchange2013Standard - integer
Number of mailboxes for the domain with standard exchange access
numExchange2013Premium - integer
Number of mailboxes for the domain with premium exchange access
href - string
Link to other resources relevant to the mailboxes lists
rel - string
Type of relation to the resource for the provided link

Examples

Success scenario

Request

GET accounts/test-account123/email/test.com/statistics/mailboxTypeCount
 

Response

{
    "numStandard": 1,	
    "numActiveSync": 0,	
    "numPremium": 0,
    "numExchange2013Standard": 5,
    "numExchange2013Premium": 2
    "links": [
        {
            "href": "{{APIBaseURL}}/accounts/test-account123/email/test.com/statistics/mailboxTypeCount/",
            "rel": "self"
        }
    ]
}
 

See also


blog comments powered by Disqus

Personal tools
Namespaces
Variants
Actions
APIs
Navigation
Toolbox