Analytics JavaScript (JS) API

You need to first create a client to use the JavaScript API. Create an instance of the AnalyticsClient module as follows. 

1.  Import jquery.js and carbon-analytics.js.

2. Create the connection object with the following details.

   var client = new AnalyticsClient().init();
   
   var username = "admin";
   var password = "admin";
   var server_url = "https://localhost:9443/portal/apis/analytics";

Above constructor creates an object of the AnalyticsClient module with default parameters. If you want to create an analytics client with your own parameters, use the below constructor.

var client = new AnalyticsClient().init(username, password, server_url);

Success callback function and error callback functions of the JS API

All methods of the Analytics JS API have a success function and an error function as callbacks representing successful invocations and erroneous invocations. Success callback has one argument which will contain the response it returns if the invocation is successful. It represents a JSON String of the following format.

{
  "status" : <RESPONSE_STATUS>,
  "message" : <RESPONSE_DATA_OR_MESSAGE>
}

Error callback has one argument which will contain an error message if the invocation is failed. Its JSON representation is as follows.

{
  "status" : <RESPONSE_STATUS>,
  "message" : <ERROR_MESSAGE>
}

The methods exposed by the Analytics JavaScript API are as follows.