XOMNI: Experience Omni-Channel

Last Updated: February 19, 2016

The API provides the functionality to get yearly analytics summaries.

Request

HTTP Method Resource URI
GET https://{tenantName}.api.xomni.com/private/analytics/servercounters/{counterName}/summary/yearly?startOADate={startOADate}&endOADate={endOADate}

URI Parameters

Parameter Name Description Type Conditions
counterName The name of counter. (See possible values of counter names) 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 less than a year. Number

Possible Values For CounterType

Request Headers

Parameter Name Possible Values
CounterType
WishlistByCreatedDate
WishlistByLastAccessedDate
AddedWishlistItem
RemovedWishlistItem
ShoppingCartByCreatedDate
ShoppingCartByLastAccessedDate
AddedShoppingCartItem
RemovedShoppingCartItem
ItemView
ItemLike
ItemShare
ItemShareResponse
ItemShareInteraction
OmniShare
OmniShareFromCustomerDeviceToCustomerDevice
OmniShareFromCustomerDeviceToInStoreDevice
OmniShareFromInStoreDeviceToCustomerDevice
OmniShareFromInStoreDeviceToInStoreDevice
Header Field Name Description
Content-Type
Content type of the response entity. The value of this header is always application/json.
Accept
Includes minor version header.
Sample: application/vnd.xomni.api-v4-0, */*
Authorization
Access or identity token taken from oauth APIs.
Sample: Bearer dc8f1dcdbe454da8a25621839a93569337522968019e4bd7becd6e01285444da

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
Item.Year Year of the summarized metering data. Number
Item.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) Counter name is invalid.
404 (Not Found) Analytics is not enabled. Please enable analytics functionality using tenant settings.