Skip to end of metadata
Go to start of metadata

You are viewing an old version of this page. View the current version.

Compare with Current View Page History

« Previous Version 76 Next »

JavaScript API

Use the JavaScript API to enhance your Sisense experience. Here are some examples of what you can do using the API:

  • Build new types of widgets
  • Tweak out-of-the-box visualizations to match the exact look and feel you are looking for
  • Fine tune the application behavior for specific needs
  • Apply custom formatting

 

Audience

This documentation is intended for users who are familiar with JavaScript programming and are experienced with creating dashboards using Sisense.

Use this Getting Started guide to familiarize yourself with the concepts of Sisense’s Javascript API and start enhancing Sisense with custom functionality.

Who can use the API?

Any Sisense designer can extend Sisense dashboards and widgets with the Javascript API. Limiting API usage to administrators can only be achieved using the user role customization feature.

Deploying Javascript plugins to the Sisense installation folder can be performed by anyone with access to the physical drive.

What can I do with the API?

The Sisense web application was built to be easily extensible via the Javascript API. Javascript can be implemented using the following two methods:

  • Plugins - Deploy Javascript code as plugins into the Sisense environment. This will apply your Javascript code to the entire application.
  • Dashboard and Widget extensions - Apply Javascript code via Sisense’s built in Javascript editor for specific widgets and dashboards. This will apply your code selectively to the dashboards and widgets that you choose.

Do things such as:

  • Build new types of widgets
  • Tweak out-of-the-box visualizations to match the exact look and feel you are looking for
  • Fine tune the application behavior for specific needs
  • Apply custom formatting

Here are a few examples from our forums:

To see more examples of how the API can be used to match your needs, visit our user forums:

REST API

Sisense provides a REST API that you can use to perform many of the tasks available from the web interface, as well as additional advanced tasks. These include managing ElastiCubes, user and group management, white labeling, updating user roles, etc.

You can use the API as follows:

  • Use the built-in API visualization tool, and execute direct API calls from your browser to your dashboards.
  • Call the API from outside the Sisense web environment, using your own development environment.  For example, you can create a python script that will add Sisense users in bulk. To call the API, you will need a security token.

 

Need more info?

Sisense Documentation

Sisense Support

 

 

 

 

  • No labels