XOMNI: Experience Omni-Channel

Last Updated: February 19, 2016

This API can be used to fetch client side analytics logs.

Request

HTTP Method Resource URI
GET https://{tenantName}.api.xomni.com/private/analytics/clientcounters/{counterName}/logs?OADate={OADate}&continuationKey={continuationKey}

URI Parameters

Parameter Name Description Type Conditions
counterName Name of the client side counter. String
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":"c6756fd8-f7c3-4fe4-852e-4e849c8cd943",
   "Logs":[
      {
         "CounterName":"categoryclick",
         "Value":1,
         "DataBag":"sample category",
         "CreatedDate":"2017-03-19T16:43:25.5779679+02:00"
      }
   ]
}

Response Body Description

Parameter Name Description Type
ContinuationToken Continuation key for getting further logs. String
Logs[0..N].CounterName Name of the counter. String
Logs[0..N].DataBag Random text value bag which will be provided by the client. String
Logs[0..N].Value Value for the analytics log. 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 logs found.
404 (Not Found) Analytics is not enabled. Please enable analytics functionality using tenant settings.