XOMNI: Experience Omni-Channel

Last Updated: February 19, 2016

The API provides a functionality to get trending item logs.

Request

HTTP Method Resource URI
GET https://{tenantName}.api.xomni.com/private/analytics/servercounters/trendingitem/logs?OADate={OADate}&continuationKey={continuationKey}

URI Parameters

Parameter Name Description Type Conditions
OADate Date filter in OA date format. Number
continuationKey Continuation key for getting further logs. String

Request Headers

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

{
    "ContinuationToken": "5ff2ee72-7ef6-474d-97fe-c18b8eed723b",
    "Logs": [
{
    "StoreId":33,
    "ItemId":33,
    "ItemTitle":"a766f7d9-52d9-4bd1-93a4-ef20cfecb762",
    "BrandId":33,
    "CategoryId":33,
    "ItemName":"53f61cff-9254-4bfe-8bae-d319abf43699",
    "DefaultItemId":33,
    "Model":"e3c2d9f1-2208-42d8-a9b8-f25d0ac3d2b6",
    "TotalActionTypeImpactValue":0.0,
    "TotalTimeImpactValue":0.0,
    "TotalActionCount":33,
    "CreatedDate":"2013-10-24T09:10:00Z"
      }
    ]
}

Response Body Description

Parameter Name Description Type
ContinuationToken Continuation key for getting further logs. String
Logs[0..N].StoreId Unique ID of the store. Number
Logs[0..N].ItemId Unique id of the item. Number
Logs[0..N].ItemTitle Title of the item String
Logs[0..N].BrandId The unique ID of a brand assigned to the item. Number
Logs[0..N].CategoryId The unique ID of a category assigned to the item. Number
Logs[0..N].ItemName Name of the item. String
Logs[0..N].DefaultItemId The ID of the default item in the associated variant list. If the DefaultItemID is equal to the ID, the current item is a default item in its variant list. Number
Logs[0..N].Model Model of the item. String
Logs[0..N].TotalActionTypeImpactValue Total action type impact value for the item. Number
Logs[0..N].TotalTimeImpactValue Total time impact value for the item. Number
Logs[0..N].TotalActionCount Total action count for the item. Number
Logs[0..N].CreatedDate Log date. Date

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
404 (Not Found) No log found.
404 (Not Found) Analytics is not enabled. Please enable analytics functionality using tenant settings.