XOMNI: Experience Omni-Channel

Last Updated: February 19, 2016

The API provides a functionality to get item view logs.

Request

HTTP Method Resource URI
GET https://{tenantName}.api.xomni.com/private/analytics/servercounters/itemview/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": "a9fc6086-ef70-41cf-bd44-b14513c2d2b0",
    "Logs": [
      {
          "ItemId": 65,
          "ItemTitle": "68eb62ab-5599-432c-81a8-2c4fa207de30",
          "BrandId": 65,
          "CategoryId": 65,
          "ItemName": "4228f551-ee0a-4e81-b005-7b5db3b3d706",
          "DefaultItemId": 65,
          "Model": "06d5a188-75c8-4f66-b0cb-91a011435bff",
          "CreatedDate": "2016-05-30T16:43:25.5477509+03:00"
      }
    ]
}

Response Body Description

Parameter Name Description Type
ContinuationToken Continuation key for getting further logs. String
Logs[0..N].ItemId The 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].CreatedDate Log creation 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.