XOMNI: Experience Omni-Channel

Last Updated: February 19, 2016

The API provides a functionality to get item share interaction (Social Comment) logs.

Request

HTTP Method Resource URI
GET https://{tenantName}.api.xomni.com/private//analytics/servercounters/itemshareinteraction/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": "cb1a1390-23fc-4d13-a94f-c5e4e432078a",
    "Logs": [
      {
          "TargetPostId": 65,
          "RelatedItemId": 65,
          "Content": "8cd48604-c36e-4dd5-85fb-5aa306823ea5",
          "TargetCommentId": 65,
          "CreatedDate": "2016-05-30T16:43:25.5359849+03:00"
      }
    ]
}

Response Body Description

Parameter Name Description Type
ContinuationToken Continuation key for getting further logs. String
Logs[0..N].TargetPostId The unique ID of the social post related to the social share interaction. Number
Logs[0..N].RelatedItemId The unique ID of an item related to the social post. Number
Logs[0..N].Content The text content of the social share interaction. String
Logs[0..N].TargetCommentId This is the unique ID for the social XOMNI comment which the current comment replies to. Number
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.