XOMNI: Experience Omni-Channel

Last Updated: May 05, 2016

The API provides a functionality to get omni share from in store device to customer device logs.

Request

HTTP Method Resource URI
GET https://{tenantName}.api.xomni.com/private//analytics/servercounters/omnisharefrominstoredevicetocustomerdevice/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.
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

{
    "ContinuationToken": "5ff2ee72-7ef6-474d-97fe-c18b8eed723b",
    "Logs": [
      {
          "SharedFromPhysicalDeviceId : "49",
          "SharedFromPhysicalDeviceDescription": "4661898f-cd8a-4f38-974e-6d4475532945",
          "SharedToPhysicalDeviceId : "49",
          "SharedToPhysicalDeviceDescription": "92bcfc0d-041a-4fad-9e9c-22f3507539bf",
          "PIIUserId": 49,
          "PIIUsername": "6e1fca98-ed42-4b26-ab5f-730ad5fc1cca",
          "OmniTicket": "b0f5c18b-b19c-47b2-a702-9c7621e3052f",
          "CreatedDate": "2015-09-28T16:43:25.5506455+03:00"
      }
    ]
}

Response Body Description

Parameter Name Description Type
ContinuationToken Continuation key for getting further logs. String
Logs[0..N].SharedFromPhysicalDeviceId Unique ID of the physical device String
Logs[0..N].SharedFromPhysicalDeviceDescription Description of the physical device String
Logs[0..N].SharedToPhysicalDeviceId Unique ID of the physical device. String
Logs[0..N].SharedToPhysicalDeviceDescription Unique ID of the physical device. String
Logs[0..N].PIIUserId Unique ID of the PII user Number
Logs[0..N].PIIUsername Username of the PII user String
Logs[0..N].OmniTicket OmniTicket value. Unknown
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.