XOMNI: Experience Omni-Channel

Last Updated: May 05, 2016

This API can be used to log custom client side analytics. Maximum client side log per request is 1000 logs.

Request

[  
   {  
      "CounterName":"Sample CounterName",
      "CreatedDate":"2015-02-25T11:13:10.582049+02:00",
      "Value":1,
      "DataBag":"Sample DataBag"
   },
   {  
      "CounterName":"Sample CounterName",
      "CreatedDate":"2015-02-25T11:13:10.582049+02:00",
      "Value":1,
      "DataBag":"Sample DataBag"
   }
]
HTTP Method Resource URI
POST https://{tenantName}.api.xomni.com/analytics/clientlogs

Request Body Description

Parameter Name Description Type Conditions
CounterName Name of the client side analytics counter. This field can contain any string according to client side scenarios. String
Required
CreatedDate Creation date for the analytics log. Date
Required
Value Value for the analytics log. Number
Required.
DataBag Random text value bag which will be provided by the client. 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

The response does not contain any response entity if the status is successful.

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 POST operations. Possible response status codes are as listed below:

Status Code Description
202 (Accepted) Logging successfully completed.
400 (Bad Request) Max log limit per request exceeded.
404 (Not Found) Analytics is not enabled. Please enable analytics functionality using tenant settings.