XOMNI: Experience Omni-Channel

Last Updated: May 05, 2016

The API provides a functionality to get item like logs.

Request

HTTP Method Resource URI
GET https://{tenantName}.api.xomni.com/private/analytics/servercounters/itemlike/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": "cb1a1390-23fc-4d13-a94f-c5e4e432078a",
    "Logs": [
      {
          "TargetPostId": 65,
          "RelatedItemId": 65,
          "TargetPlatform":"Facebook",
          "LikeCount":13,
          "KnownPIIUserIds":  [
	  {
		1,
		2,
		3
	  }
	],
          "UnknownUserProfiles":  [
	  {
      "Id": "100005298216720",
      "FirstName": "Gökhan",
      "LastName": "Gülbiz",
      "DisplayName": "Gökhan Gülbiz",
      "PhotoUrl": "http://graph.facebook.com/100005298216720/picture",
	  }
	],

          "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].TargetPlatform Name of the social platform that social information belongs to. String
Logs[0..N].TargetPostId The unique ID of the social post. Number
Logs[0..N].RelatedItemId The unique ID of an item related to the social post. Number
Logs[0..N].KnownPIIUserIds A collection of known PII user IDs in social post’s likes. Array
Logs[0..N].LikeCount Total like count of the social post. Number
Logs[0..N].CreatedDate Log creation date. Date
Logs[0..N].UnknownUserProfiles[0..N].Id The unique social platform ID of the liked. String
Logs[0..N].UnknownUserProfiles[0..N].PhotoUrl Photo URL of the user in the social platform. String
Logs[0..N].UnknownUserProfiles[0..N].DisplayName DisplayName of the user in the social platform. String
Logs[0..N].UnknownUserProfiles[0..N].FirstName First Name of the user in the social platform. String
Logs[0..N].UnknownUserProfiles[0..N].LastName Last Name of the user in the social platform. String

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.