XOMNI: Experience Omni-Channel

Last Updated: February 19, 2016

The API provides a functionality to get item share response (External social platform comment) logs.

Request

HTTP Method Resource URI
GET https://{tenantName}.api.xomni.com/private/analytics/servercounters/itemshareresponse/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": "c3082270-d524-4883-86f3-e1e8868a1b83",
    "Logs": [
      {
          "TargetPostId": 65,
          "Content": "16d54660-5a3b-453d-9861-99d6f2e696d3",
          "AuthorName": "313db456-c8d2-4917-903a-2e12a71ad5de",
          "SocialPlatformId": 65,
          "PlatformDependentId": "c9ee4f35-088a-41f4-811b-6e312cc8143d",
          "CreatedDate": "2016-05-30T16:43:25.5438101+03:00"
      }
    ]
}

Response Body Description

Parameter Name Description Type
ContinuationToken Continuation key for getting further logs. String
Logs[0..N].TargetPostId This is the unique ID for the social XOMNI post which the current comment replies to and belongs to. Number
Logs[0..N].Content The text content of the comment. String
Logs[0..N].AuthorName Display name of the user in the social platform. String
Logs[0..N].SocialPlatformId The unique id of the social platform. Number
Logs[0..N].PlatformDependentId The unique platform dependent id of the social share response. 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.