Developer Portal
Last Updated: May 05, 2016
Getting Analytics Yearly Summaries
The API provides the functionality to get yearly client analytics summaries.
Request
| HTTP Method | Resource URI |
|---|---|
| GET | https://{tenantName}.api.xomni.com/private/analytics/clientcounters/{counterName}/summary/yearly?startOADate={startOADate}&endOADate={endOADate} |
URI Parameters
| Parameter Name | Description | Type | Conditions |
|---|---|---|---|
| counterName | Counter name. | String | |
| startOADate | Start date filter in OA date format. | Number | |
| endOADate | End date filter in OA date format. Start and date range filter must be more than a year. | Number |
Request Headers
| Header Field Name | Description |
|---|---|
| Content-Type |
Content type of the response entity. The value of this header is always application/json.
|
| Authorization |
Access or identity token taken from oauth APIs.
Sample: Bearer dc8f1dcdbe454da8a25621839a93569337522968019e4bd7becd6e01285444da
|
| Accept |
Includes minor version header.
Sample: application/vnd.xomni.api-v4-1, */*
|
Response
[
{
"Year": 2015,
"TotalCount": 91
},
{
"Year": 2015,
"TotalCount": 135
},
{
"Year": 2015,
"TotalCount": 106
},
{
"Year": 2015,
"TotalCount": 139
},
{
"Year": 2015,
"TotalCount": 81
}
]
Response Body Description
| Parameter Name | Description | Type |
|---|---|---|
| Year | Year of the summarized metering data. | Number |
| TotalCount | TotalCount of the counter. | Number |
Response Headers
| Header Field Name | Description |
|---|---|
| Content-Type |
Content type of the response entity. The value of this header is always application/json.
|
Status Codes
A successful operation returns status code 200 (OK) for GET operations. Possible response status codes are as listed below:
| Status Code | Description |
|---|---|
| 400 (Bad Request) | Invalid date range filter. |
| 404 (Not Found) | Analytics is not enabled. Please enable analytics functionality using tenant settings. |