The validate activation token endpoint receives the temporary activation token generated by begin_activate and either returns the username of the user to be activated, or an error if the token is invalid, for example if it was already used.
Parameters
Parameter
Description
Parameter Type
Data Type
token
The user's activation token.
path
string
Response Class
Code Block
{
"userName": "string"
}
Error Status Codes
HTTP Status Code
Reason
200
Token validated
404
Provided token is invalid
Status
colour
Blue
title
GET
/account/get_license_info
Expand
title
Returns your Sisense licensing information
The license info endpoint returns a list of features enabled on your account and the number of users in use versus the total number of users available for your account.
The validate password reset token endpoint receives the temporary password reset token generated by begin_reset_password and either returns the username of the user who's password will be reset, or an error if the token is invalid, for example if it was already used.
Parameters
Parameter
Description
Parameter Type
Data Type
token
The temporary password reset token
path
string
Response Class
Code Block
{
"userName": "string"
}
Error Status Codes
HTTP Status Code
Reason
200
Reset token is valid
404
Reset token is invalid
Status
colour
Green
title
POST
/account/begin_activate
Expand
title
Begin user activation
The begin activation endpoint is the starting point for the user activation process. It generates a temporary activation token for the user associated with the provided email address and sends an activation email to them.
Parameters
Parameter
Description
Parameter Type
Data Type
emailObj
The email address of the user to be activated.
body
Code Block
title
Object [ schema ]:
{
"email": "string"
}
Error Status Codes
HTTP Status Code
Reason
204
Email sent successfully
404
Invalid email
Status
colour
Green
title
POST
/account/activate/{token}
Expand
title
Activate user
The activate endpoint receives the activation token and a new password and updates the user's password accordingly.
Parameters
Parameter
Description
Parameter Type
Data Type
token
The user's activation token.
path
string
passwordObject
The new password (MD5).
body
Code Block
title
Object [ schema ]:
{
"password": "string"
}
Error Status Codes
HTTP Status Code
Reason
204
User activated successfully
404
Invalid activation token
Status
colour
Green
title
POST
/account/begin_activate_bulk
Expand
title
Bulk begin user activation
The bulk begin activation endpoint is the starting point for the user activation process when activating multiple users. It generates a temporary activation token for the users associated with the provided email addresses and sends an activation email to them.
Parameters
Parameter
Description
Parameter Type
Data Type
emailList
The list of user emails to be activated.
body
Code Block
title
Object [ schema ]:
[
{
"email": "string"
}
]
Error Status Codes
HTTP Status Code
Reason
204
Email sent successfully
404
Invalid email
Status
colour
Green
title
POST
/account/begin_reset_password
Expand
title
Begin reset password process
The begin reset password endpoint is the starting point for the password reset process. It generates a temporary password reset token for the user associated with the provided email address and sends a password reset email to them.
Parameters
Parameter
Description
Parameter Type
Data Type
emailObject
The email address of the user whose password needs to be reset.
body
Code Block
title
Object [ schema ]:
{
"email": "string"
}
Error Status Codes
HTTP Status Code
Reason
204
Email sent successfully
404
Invalid email
Status
colour
Green
title
POST
/account/reset_password/{token}
Expand
title
Finalize password reset
The reset password endpoint receives the reset password token and a new password and updates the user's password accordingly.
Parameters
Parameter
Description
Parameter Type
Data Type
token
The temporary password reset token.
path
string
passwordObject
The new password (MD5).
body
Code Block
title
Object [ schema ]:
{
"password": "string"
}
Error Status Codes
HTTP Status Code
Reason
204
Password was reset successfully
404
Reset token is invalid
Admin
Status
colour
Blue
title
GET
/dashboards/admin
Expand
title
Get all dashboards
The get all dashboards endpoint provides access to all available dashboards in their stored format as JSON objects. Its results can be filtered by parameters such as dashboard type, dashboard name, parent folder, or datasource.
The replace datasource endpoint replaces the datasource object of all the dashboards and widgets in the system.
Parameters
Parameter
Description
Parameter Type
Data Type
authorization
The user's API token, preceded by the keyword Bearer (with a space between it and the token). For more information, please refer to the API tutorial.
header
string
server
Datasource server("Set" for elasticbe sets) to update.
path
string
title
Datasource title to update.
path
string
dashboardId
The ID of the dashboard to get.
query
string
datasource
The new datasource object.
The recommended way for locating the details of a datasource is to retrieve a dashboard that uses the datasource already. Through the GET /dashboards/{id} endpoint, you can enter your dashboard's ID and retrieve the dashboard's details, which includes the datasource object. This object contains all the information you need to replace your datasource, for example, the details of a sample dashboard and its datasource are as follows:
The get alert endpoint provides access to a specified user's alert in their stored format as JSON objects.
Parameters
Parameter
Description
Parameter Type
Data Type
authorization
The user's API token, preceded by the keyword Bearer (with a space between it and the token). For more information, please refer to API tutorial.
header
string
ids
Array of alert IDs to get separated by a comma (,) and without spaces.
query
Array[string]
fields
Whitelist of fields to return for each document. fields Can also define which fields to exclude by prefixing field names with -.
query
string
sort
Field by which the results should be sorted. Ascending by default, descending if prefixed by -.
query
string
skip
Number of results to skip from the start of the data set. skip is to be used with the limit parameter for paging.
query
number
limit
How many results should be returned. limit is to be used with the skip parameter for paging.
query
number
expand
List of fields that should be expanded (substitures their IDs with actual objects). May be nested using the resource.subResource format.
query
string
Status
colour
Blue
title
GET
/alerts/{id}
Expand
title
Get a specific alert
The get alert by ID endpoint returns a specific alert object by ID.
Parameters
Parameter
Description
Parameter Type
Data Type
authorization
The user's API token, preceded by the keyword Bearer (with a space between it and the token). For more information, please refer to API tutorial.
header
string
id
The ID of the alert to get.
path
string
Status
colour
Blue
title
GET
/alerts/count
Expand
title
Get the amount of alerts for a user
The alerts count endpoint returns the amount of alerts for a user if the user is the owner of the alerts.
Parameters
Parameter
Description
Parameter Type
Data Type
authorization
The user's API token, preceded by the keyword Bearer (with a space between it and the token). For more information, please refer to API tutorial.
header
string
Status
colour
Green
title
POST
/alerts
Expand
title
Add a new alert
The add alert endpoint receives an alert object and adds it to the system's alerts.
Parameters
Parameter
Description
Parameter Type
Data Type
authorization
The user's API token, preceded by the keyword Bearer (with a space between it and the token). For more information, please refer to API tutorial.
header
string
alert
Basic alert object to be added.
body
object
Status
colour
Yellow
title
PATCH
/alerts/{id}
Expand
title
Update an alert
The update alert endpoint performs a partial update on the alert of the defined ID, updating the fields in the alert object defined in the body. The fields that can be updated are name, enabled, message, parties, action, context.
Parameters
Parameter
Description
Parameter Type
Data Type
authorization
The user's API token, preceded by the keyword Bearer (with a space between it and the token). For more information, please refer to API tutorial.
header
string
id
The ID of the alert to be updated.
path
string
alert
The partial alert object whose field will be updated.
body
object
Status
colour
Yellow
title
PATCH
/alerts/{id}/setReceiveNotification
Expand
title
Update alert's disabled users
The update receive notification endpoint removes or adds a specific user to be notified when the alert is being executed.
Parameters
Parameter
Description
Parameter Type
Data Type
authorization
The user's API token, preceded by the keyword Bearer (with a space between it and the token). For more information, please refer to API tutorial.
header
string
id
The ID of the alert to be updated.
path
string
alert
The user and parameter Whether to disable or enable the user.
body
object
Status
colour
Red
title
DELETE
/alerts/{id}
Expand
title
Delete an alert
The delete alert endpoint deletes an alert and all of it's related events.
Parameters
Parameter
Description
Parameter Type
Data Type
authorization
The user's API token, preceded by the keyword Bearer (with a space between it and the token). For more information, please refer to API tutorial.
header
string
id
The ID of the alert to be deleted.
path
string
Analytics
Status
colour
Blue
title
GET
/analytics/token
Expand
title
Get token for Sisense Analytics
Returns a token used to authenticate calls to /analytics API endpoints. You must provide this token when making calls to the /analytics/collection/{collection} endpoint.
Parameters
Parameter
Description
Parameter Type
Data Type
authorization
The user's API token, preceded by the keyword Bearer (with a space between it and the token). For more information, please refer to API tutorial.
header
string
Status
colour
Blue
title
GET
/analytics/token/revoke
Expand
title
Revoke token for Sisense Analytics
Revoke the token used to authenticate your calls to /analytics endpoints.
Parameters
Parameter
Description
Parameter Type
Data Type
authorization
The user's API token, preceded by the keyword Bearer (with a space between it and the token). For more information, please refer to API tutorial.
header
string
Status
colour
Blue
title
GET
/analytics/collection/{collection}
Expand
title
Get the entire collection based on the received parameter
Returns a collection of Sisense entities as defined in the collection parameter. Entities include objects such as ElastiCubes, widgets,users, groups, or dashboards.
Parameters
Parameter
Description
Parameter Type
Data Type
authorization
The /analytics endpoint API token, preceded by the keyword Bearer (with a space between it and the token). For more information, please refer to API tutorial. You can retrieve this token through the /analytics/token endpoint.
header
string
collection
Collection name to be returned.
path
string
Application
Status
colour
Blue
title
GET
/application/status
Expand
title
Get the application's status
The application status endpoint provides information on the current status of the Sisense application. It provides the version number and some licensing information.
The logout endpoint revokes the given user's token, ensuring requests made with it will no longer work. A new token may be generated using the login endpoint.
Parameters
Parameter
Description
Parameter Type
Data Type
x-device-id
The device ID.
header
string
authorization
The user's API token, preceded by the keyword Bearer (with a space between it and the token). For more information, please refer to API tutorial.
header
string
collection
Collection name to be returned.
query
string
Error Status Codes
HTTP Status Code
Reason
204
Log out was performed successfully. The API token has been revoked.
401
Unauthorized: Invalid API token.
Status
colour
Blue
title
GET
/authentication/logout_all
Expand
title
Log out and revoke all users' tokens
The logout all endpoint revokes all if a user's existing tokens, both for the API and all devices.
Parameters
Parameter
Description
Parameter Type
Data Type
x-device-id
The device ID.
header
string
authorization
The user's API token, preceded by the keyword Bearer (with a space between it and the token). For more information, please refer to API tutorial.
header
string
Error Status Codes
HTTP Status Code
Reason
204
Log out was performed successfully. The API token has been revoked.
401
Unauthorized: Invalid API token.
Status
colour
Blue
title
GET
/authentication/admin/logout
Expand
title
Revoke all tokens for multiple users
The admin logout endpoint allows admin users to revoke all tokens of multiple users.
Parameters
Parameter
Description
Parameter Type
Data Type
x-device-id
The device ID.
header
string
authorization
The user's API token, preceded by the keyword Bearer (with a space between it and the token). For more information, please refer to API tutorial.
header
string
users
User IDs whose tokens are to be revoked, separated by a comma (,) and without spaces
query
Array[string]
Error Status Codes
HTTP Status Code
Reason
204
Tokens revoked successfully
401
Invalid token
Status
colour
Blue
title
GET
/authentication/server_access
Expand
title
Get a list of trusted servers
The get all servers access endpoint returns a list of trusted servers that can copy dashboards to your server.
Parameters
Parameter
Description
Parameter Type
Data Type
authorization
The user's API token, preceded by the keyword Bearer (with a space between it and the token). For more information, please refer to API tutorial.
header
string
Error Status Codes
HTTP Status Code
Reason
200
An array of trusted servers
Status
colour
Green
title
POST
/authentication/login
Expand
title
Authenticate and receive token
The login endpoint validates passed credentials and returns an API token for subsequent requests to the API.
Unauthorized: Invalid credentials. Wrong username or password.
Status
colour
Green
title
POST
/authentication/server_access
Expand
title
Add a trusted server
The add server access endpoint adds a trusted server with access to Sisense.
Parameters
Parameter
Description
Parameter Type
Data Type
authorization
The user's API token, preceded by the keyword Bearer (with a space between it and the token). For more information, please refer to API tutorial.
header
string
serverAccess
The server object (in JSON notation) to be added to the Trusted Server list.
body
Error Status Codes
HTTP Status Code
Reason
200
Server was added
400
Server already exists
Status
colour
Green
title
POST
/authentication/login_saml_callback
Expand
title
Receive a token for SAML authentication
The login_saml_callback endpoint receives passed SAML credentials and returns an API token for subsequent requests to the API.
Parameters
Parameter
Description
Parameter Type
Data Type
RelayState
The original URL that the user requested.
formData
string
SAMLResponse
Response from SAML identity provider with decoded user data.
formData
string
Error Status Codes
HTTP Status Code
Reason
302
Redirect to the original URL
Status
colour
Yellow
title
PATCH
/authentication/server_access/{id}
Expand
title
Edit a trusted server
The patch servers access endpoint edits a trusted server by its ID. You can revtrive the ID throught the get servers access endpoint.
Parameters
Parameter
Description
Parameter Type
Data Type
authorization
The user's API token, preceded by the keyword Bearer (with a space between it and the token). For more information, please refer to API tutorial.
header
string
id
The ID of the trusted server.
path
string
serverAccess
The server object (in JSON notation) to be edited in the Trusted Server list.
body
Error Status Codes
HTTP Status Code
Reason
200
No response was specified
Status
colour
Red
title
DELETE
/authentication/server_access/{id}
Expand
title
Remove a trusted server's access
The delete servers access endpoint removes a trusted server from the Trusted Server Access list.
Parameters
Parameter
Description
Parameter Type
Data Type
authorization
The user's API token, preceded by the keyword Bearer (with a space between it and the token). For more information, please refer to API tutorial.
header
string
id
The ID of the trusted server.
path
string
Error Status Codes
HTTP Status Code
Reason
200
No response was specified
Status
colour
Red
title
DELETE
/authentication/admin/tokens/{tokenType}
Expand
title
Revoke API tokens for multiple users
The admin delete tokens endpoint allows admin users to revoke all API tokens of multiple users, leaving the device tokens intact.
Parameters
Parameter
Description
Parameter Type
Data Type
authorization
The user's API token, preceded by the keyword Bearer (with a space between it and the token). For more information, please refer to API tutorial.
header
string
tokenType
The ID of the trusted server.
path
string
users
User IDs whose tokens are to be revoked, separated by a comma (,) and without spaces.
query
Array[string]
Error Status Codes
HTTP Status Code
Reason
204
API token revoked successfully
401
Invalid token
Connections
Status
colour
Blue
title
GET
/connection
Expand
title
Returns a list of connections
The get connection endpoint returns a list of configured connections.
Parameters
Parameter
Description
Parameter Type
Data Type
sort
Determines how the results should be sorted. Ascending by default, descending if prefixed by -
query
string
skip
Number of results to skip from the start of the data set. skip is to be used with thelimitparameter for paging
query
integer
limit
How many results should be returned. limit is to be used with the skip parameter for paging
query
intege
Status
colour
Blue
title
GET
/connection/{id}
Expand
title
Returns a connection by its ID
The get connection by ID endpoint returns a connection object by ID.
Parameters
Parameter
Description
Parameter Type
Data Type
authorization
The user's API token, preceded by the keyword Bearer (with a space between it and the token). For more information, please refer to API tutorial.
header
string
id
The ID of the live connection. You can retrieve this ID through the get /connection endpoint.
path
integer
Status
colour
Blue
title
GET
/connection/recent
Expand
title
Returns recently used connection objects
The list connections endpoint returns list of recently used connections.
Status
colour
Green
title
POST
/connection
Expand
title
Creates a new connection
The create connection endpoint creates a new connection object.
Parameters
Parameter
Description
Parameter Type
Data Type
authorization
The user's API token, preceded by the keyword Bearer (with a space between it and the token). For more information, please refer to API tutorial.
header
string
connection
The new connection object.
body
Status
colour
Yellow
title
PATCH
/connection/{id}
Expand
title
Updates a connection
The update connection endpoint updates a connection with new data.
Parameters
Parameter
Description
Parameter Type
Data Type
authorization
The user's API token, preceded by the keyword Bearer (with a space between it and the token). For more information, please refer to API tutorial.
header
string
id
The ID of the live connection. You can retrieve this ID through the get /connection endpoint.
path
string
connection
The new connection object.
body
Status
colour
Red
title
DELETE
/connection/{id}
Expand
title
Removes a connection
The delete connection endpoint removes a connection by ID.
Parameters
Parameter
Description
Parameter Type
Data Type
authorization
The user's API token, preceded by the keyword Bearer (with a space between it and the token). For more information, please refer to API tutorial.
header
string
id
The ID of the live connection. You can retrieve this ID through the get /connection endpoint.
path
string
Custom
Status
colour
Blue
title
GET
/custom_data
Expand
title
Get all custom data
The get custom data endpoint returns a list of arrays that contain the content of all your custom data added to the Sisense MongoDB.
Parameters
Parameter
Description
Parameter Type
Data Type
authorization
The user's API token, preceded by the keyword Bearer (with a space between it and the token). For more information, please refer to API tutorial.
header
string
Status
colour
Green
title
POST
/custom_data
Expand
title
Add a new custom object
The post custom data endpoints creates and stores a custom data object in the Sisense MongoDB that you can leverage when developing Sisense plug-ins.
Parameters
Parameter
Description
Parameter Type
Data Type
authorization
The user's API token, preceded by the keyword Bearer (with a space between it and the token). For more information, please refer to API tutorial.
header
string
customDataObject
Custom data object to be added.
body
Status
colour
Green
title
POST
/custom_data/query
Expand
title
Get documents based on query
The get documents endpoint returns all document that match the query.
Parameters
Parameter
Description
Parameter Type
Data Type
authorization
The user's API token, preceded by the keyword Bearer (with a space between it and the token). For more information, please refer to API tutorial.
header
string
query
The query to the MongoDB Collection.
body
Status
colour
Yellow
title
PATCH
/custom_data/query
Expand
title
Update documents based on a query
The update documents endpoint updates (not rewrites) all documents that match query.
Parameters
Parameter
Description
Parameter Type
Data Type
authorization
The user's API token, preceded by the keyword Bearer (with a space between it and the token). For more information, please refer to API tutorial.
header
string
queryAndData
queryForSearch is a query object to find records that need to be updated. objectForUpdate is the replacement object.
body
Status
colour
Red
title
DELETE
/custom_data/query
Expand
title
Get documents based on query
The get documents endpoint returns all document that match the query.
Parameters
Parameter
Description
Parameter Type
Data Type
authorization
The user's API token, preceded by the keyword Bearer (with a space between it and the token). For more information, please refer to API tutorial.
header
string
query
Query to find and delete documents.
body
Dashboards
Status
colour
Blue
title
GET
/dashboards
Expand
title
Get a dashboard
The get dashboards endpoint provides access to a dashboard of a user based on the token provided as the value of the authorization parameter. It's results can be filtered by parameters such as dashboard name, parent folder, or datasource.
The only expandable field for the dashboard object is widgets.
Parameters
Parameter
Description
Parameter Type
Data Type
authorization
The user's API token, preceded by the keyword Bearer (with a space between it and the token). For more information, please refer to the API tutorial
header
string
parentFolder
Parent folder ID to filter by
query
string
name
Name to filter by
query
string
datasourceTitle
Data source name to filter by
query
string
datasourceAddress
Data source address to filter by
query
string
fields
Whitelist of fields to return for each document. Can also define which fields to exclude by prefixing field names with -
query
string
sort
Field by which the results should be sorted. Ascending by default, descending if prefixed by -
query
string
expand
List of fields that should be expanded (substitutes their IDs with actual objects). May be nested using the resource.subResource format
The export dashboards endpoint returns the dashboards JSON content in a .dash file, which can be imported into Sisense.
Parameters
Parameter
Description
Parameter Type
Data Type
authorization
The user's API token, preceded by the keyword Bearer (with a space between it and the token). For more information, please refer to the API tutorial
header
string
dashboardId
The IDs of the dashboards to be exported.
query
Array[string]
Error Status Codes
HTTP Status Code
Reason
404
Dashboard not found
Status
colour
Blue
title
GET
/dashboards/{id}/export/png
Expand
title
Get a dashboard as .png image
The export dashboard to .png endpoint returns the requested dashboard rendered as a .png image file. It can be configured to export images of different width, and to include or exclude certain parts (such as dashboard filters). Note that dashboards rendered this way have a different layout to dashboards displayed in the application, called the reporting layout.
Parameters
Parameter
Description
Parameter Type
Data Type
authorization
The user's API token, preceded by the keyword Bearer (with a space between it and the token). For more information, please refer to the API tutorial
header
string
id
The ID of the dashboard to export
path
string
includeTitle
Should dashboard title be included in the exported file
query
boolean
includeFilters
Should dashboard filters be included in the exported file
query
boolean
includeDs
Should dashboard data source info be included in the exported file
query
boolean
width
Render width in pixels
query
string
Error Status Codes
HTTP Status Code
Reason
200
Image file
Status
colour
Blue
title
GET
/dashboards/{id}/export/pdf
Expand
title
Get a dashboard as .pdf file
The export dashboard to .pdf endpoint returns the requested dashboard rendered as a .pdf document file. It can be configured to export PDFs of different paper sizes, orientation, as well as to include or exclude certain parts (such as dashboard filters). Note that dashboards rendered this way have a different layout to dashboards displayed in the application, and can be either the as is layout (the reporting layout) or the feed layout which puts each widget in it's own line.
Parameters
Parameter
Description
Parameter Type
Data Type
authorization
The user's API token, preceded by the keyword Bearer (with a space between it and the token). For more information, please refer to the API tutorial
header
string
id
The ID of the dashboard to export
path
string
paperFormat
What paper format should be used while rendering the dashboard
query
string
paperOrientation
What paper orientation should be used while rendering the dashboard
query
string
layout
What layout should be used while rendering the dashboard, as is or feed
query
string
includeTitle
Include dashboard title in the exported file
query
boolean
includeFilters
Include dashboard filters in the exported file
query
boolean
includeDs
Include dashboard data source details in the exported file
query
boolean
widgetid
Enter the ID of the widget to be exported. This option is only available for Pivot and Table widgets
query
string
preview
If a report was created on a prior to Sisense V6.5 and was never updated in a newer version of Sisense, then Sisense continues to send the old dashboard report. If this value is true, and the report was created in Sisense V6.5 and later, Sisense sends the updated dashboard reports.
query
boolean
rowCount
The amount of Pivot or Table rows to be exported. This option is only available for Pivot and Table widgets
query
double
showTitle
Include the Pivot or Table widget's title in the exported file. This option is only available for Pivot and Table widgets
query
boolean
showFooter
Include the Pivot or Table widget's footer in the exported file. This option is only available for Pivot and Table widgets
query
boolean
title
Enter the Pivot or Table widget's title text to be displayed in the exported file. This option is only available for Pivot and Table widgets
query
string
titleSize
Select the Pivot or Table widget's title size to be displayed in the exported file. This option is only available for Pivot and Table widgets
query
string
titlePosition
Select the Pivot or Table widget's title position to be displayed in the exported file. This option is only available for Pivot and Table widgets
query
string
Error Status Codes
HTTP Status Code
Reason
200
PDF file
Status
colour
Blue
title
GET
/dashboards/{id}/export/dash
Expand
title
Get a dashboard as .dash file
The export dashboard to .dash file endpoint returns the dashboard's JSON in a .dash file that can be later imported into Sisense.
Parameters
Parameter
Description
Parameter Type
Data Type
authorization
The user's API token, preceded by the keyword Bearer (with a space between it and the token). For more information, please refer to the API tutorial
header
string
id
The ID of the dashboard to export
path
string
Error Status Codes
HTTP Status Code
Reason
200
Dash file
Status
colour
Blue
title
GET
/dashboards/{dashboardId}/shares
Expand
title
Get a dashboard's shares
The get shares endpoint returns a dashboard's share configurations.
The expandable fields for the shares object are group and user.
Parameters
Parameter
Description
Parameter Type
Data Type
authorization
The user's API token, preceded by the keyword Bearer (with a space between it and the token). For more information, please refer to the API tutorial
header
string
dashboardId
The ID of the dashboard who's shares to get.
path
string
fields
Whitelist of fields to return for each document. Can also define which fields to exclude by prefixing field names with -
query
string
expand
List of fields that should be expanded (substitutes their IDs with actual objects). May be nested using the resource.subResource format
An array of the dashboard's sharing configurations
404
expand resource not found
Status
colour
Blue
title
GET
/dashboards/{dashboardId}/widgets
Expand
title
Get a dashboard's widgets
The get dashboard widgets endpoint returns an array of a dashboard's widgets. The result can be filtered by different parameters such as the widget type or title.
Parameters
Parameter
Description
Parameter Type
Data Type
authorization
The user's API token, preceded by the keyword Bearer (with a space between it and the token). For more information, please refer to the API tutorial
header
string
dashboardId
The ID of the dashboard to get
path
string
title
Widget title to filter by
query
string
type
Widget type to filter by
query
string
subtype
Widget sub-type to filter by
query
string
fields
Whitelist of fields to return for each document. Can also define which fields to exclude by prefixing field names with -
query
string
sort
Field by which the results should be sorted. Ascending by default, descending if prefixed by -
query
string
skip
Number of results to skip from the start of the data set. To be used with the limit parameter for paging
query
integer
limit
How many results should be returned. To be used with the skip parameter for paging
The export widget to .png endpoint returns a specified widget rendered as a .png image. The desired output image size (height & width) must be specified.
Parameters
Parameter
Description
Parameter Type
Data Type
authorization
The user's API token, preceded by the keyword Bearer (with a space between it and the token). For more information, please refer to the API tutorial
header
string
dashboardId
The ID of the dashboard containing the widget
path
string
id
The ID of the widget to export
path
string
width
Render width in pixels
query
string
height
Render height in pixels
query
string
Error Status Codes
HTTP Status Code
Reason
200
Image file
Status
colour
Green
title
POST
/dashboards
Expand
title
Add a new dashboard
The add dashboard endpoint receives a dashboard object and adds it to the user's dashboards.
Parameters
Parameter
Description
Parameter Type
Data Type
authorization
The user's API token, preceded by the keyword Bearer (with a space between it and the token). For more information, please refer to the API tutorial
The copy dashboards to server endpoint copies the seleteced dashboards to a remote Sisense server.
Parameters
Parameter
Description
Parameter Type
Data Type
authorization
The user's API token, preceded by the keyword Bearer (with a space between it and the token). For more information, please refer to the API tutorial
header
string
copyRequest
The copy request object.
body
republish
Republish dashboards on target server after copying (only affects overwritten dashboards that were previously shared at target server).
query
boolean
force
Continue even when the dashboard is not compatible with the target server's version of Sisense.
query
boolean
Error Status Codes
HTTP Status Code
Reason
200
The dashboards were copied
Status
colour
Green
title
POST
/dashboards/import
Expand
title
Import a dashboard
The import dashboard endpoint receives the metadata of a dashboard and import the dashboard on to another Sisense instance.
Parameters
Parameter
Description
Parameter Type
Data Type
authorization
The user's API token, preceded by the keyword Bearer (with a space between it and the token). For more information, please refer to the API tutorial
header
string
dashboard
Basic dashboard object to be added. To import a dashboard through the REST API, you need to provide the dashboard's metadata. This data describes where the dashboard and its widgets. Metadata includes IDs defined by Sisense, for example, dashboard, owner, and folder IDs. These unique IDs are used to identify a dashboards and folders instead of the names you provided, which might be used on other servers. You can retrieve a dashboard's metadata through the GET /dashboards endpoint. This endpoint provides the correct values that you need to use when importing a dashboard. For example, if you want to import a dashboard into a specific folder, you need to run the GET /dashboards call on the target and source servers. On the target server where you want to import the dashboard you can retrieve the folder ID and server address. On the source server you can retrieve the metadata for the dashboard to be imported. After you have all the necessary information, through this endpoint, you can define the relevant values and import the dashboard.
The import dashboard endpoint receives a .dash file containing dashboards and adds those dashboards to the user's Dashboard list.
Parameters
Parameter
Description
Parameter Type
Data Type
authorization
The user's API token, preceded by the keyword Bearer (with a space between it and the token). For more information, please refer to the API tutorial
header
string
dashboards
Basic dashboard object to be added.
body
action
Determines if the existing dashboard should be overwritten. skip: The existing dashboard is not overwritten. overwrite: The existing dashboard is overwritten. duplicate: A new copy of the existing dashboard is created on the target server.
query
string
republish
Republish dashboards on target server after copying (only affects overwritten dashboards that were previously shared on the target server).
query
boolean
importFolder
The folder to add the imported dashboard to.
query
string
Status
colour
Green
title
POST
/dashboards/{id}/restore
Expand
title
Restores a dashboard
The restore dashboard endpoint restores the dashboard to the last version published by the dashboard owner. All local changes to the dashboard will be overridden.
Parameters
Parameter
Description
Parameter Type
Data Type
authorization
The user's API token, preceded by the keyword Bearer (with a space between it and the token). For more information, please refer to the API tutorial
header
string
id
The ID of the dashboard to be restored.
path
string
Error Status Codes
HTTP Status Code
Reason
204
Operation was successfull
404
Dashboard not found
Status
colour
Green
title
POST
/dashboards/{id}/publish
Expand
title
Publish a dashboard
The publish dashboard endpoint sets the dashboard as the published version of it for the shared users to see.
Parameters
Parameter
Description
Parameter Type
Data Type
authorization
The user's API token, preceded by the keyword Bearer (with a space between it and the token). For more information, please refer to the API tutorial
header
string
id
The ID of the dashboard to publish
path
string
Error Status Codes
HTTP Status Code
Reason
204
Operation was successfull
404
Dashboard not found
Status
colour
Green
title
POST
/dashboards/{id}/undo_Import
Expand
title
Restores a dashboard
The undo import dashboard endpoint restores the previous dashboard for a dashboard that has been imported. All local changes to the dashboard will be overridden.
Parameters
Parameter
Description
Parameter Type
Data Type
authorization
The user's API token, preceded by the keyword Bearer (with a space between it and the token). For more information, please refer to the API tutorial
header
string
id
The ID of the dashboard to be restored
path
string
Error Status Codes
HTTP Status Code
Reason
204
Operation was successfull
404
Dashboard not found
Status
colour
Green
title
POST
/dashboards/{id}/duplicate
Expand
title
Duplicate a dashboard
The duplicate dashboard endpoint creates a new dashboard based on an existing dashboard of the provided ID.
Parameters
Parameter
Description
Parameter Type
Data Type
authorization
The user's API token, preceded by the keyword Bearer (with a space between it and the token). For more information, please refer to the API tutorial
header
string
id
The ID of the dashboard to duplicate
path
string
Error Status Codes
HTTP Status Code
Reason
201
No response was specified
Status
colour
Green
title
POST
/dashboards/{id}/change_owner
Expand
title
Change dashboard owner
The change owner endpoint update owner of existing and specified by ID dashboard if called by current dashboards owner.
The update dashboard endpoint will perform a partial update on the dashboard of the provided ID, updating the fields in the dashboard object provided in the body.
Parameters
Parameter
Description
Parameter Type
Data Type
authorization
The user's API token, preceded by the keyword Bearer (with a space between it and the token). For more information, please refer to the API tutorial
header
string
id
The ID of the dashboard to update
path
string
dashboard
The partial dashboard object who's fields will be updated
The update widget endpoint will perform a partial update on the dashboard's widget of the provided ID, updating the fields with the widget object provided in the body.
Parameters
Parameter
Description
Parameter Type
Data Type
authorization
The user's API token, preceded by the keyword Bearer (with a space between it and the token). For more information, please refer to the API tutorial
The delete dashboard endpoint will delete the dashboard with the provided ID.
Parameters
Parameter
Description
Parameter Type
Data Type
authorization
The user's API token, preceded by the keyword Bearer (with a space between it and the token). For more information, please refer to the API tutorial
header
string
id
The ID of the dashboard to delete
path
string
Error Status Codes
HTTP Status Code
Reason
200
Delete operation was successful
Status
colour
Red
title
DELETE
/dashboards/bulk
Expand
title
Delete a dashboard
The delete dashboard endpoint will delete the dashboard with the provided ID.
Parameters
Parameter
Description
Parameter Type
Data Type
authorization
The user's API token, preceded by the keyword Bearer (with a space between it and the token). For more information, please refer to the API tutorial
header
string
id
The ID of the dashboard to delete
path
string
Error Status Codes
HTTP Status Code
Reason
200
Delete operation was successful
Status
colour
Red
title
DELETE
/dashboards/{dashboardId}/widgets/{id}
Expand
title
Delete dashboards
The delete dashboards endpoint deletes dashboards with the provided IDs.
Parameters
Parameter
Description
Parameter Type
Data Type
authorization
The user's API token, preceded by the keyword Bearer (with a space between it and the token). For more information, please refer to the API tutorial
header
string
dashboardIds
The IDs of the dashboards to be deleted.
query
Array[string]
Error Status Codes
HTTP Status Code
Reason
200
Delete operation was successful
404
Dashboard not found
Database
Status
colour
Blue
title
GET
/database/encrypt_database_password
Expand
title
Returns an encrypted password from plaintext
The encryptDatabasePassword endpoint encrypts and returns a password from plaintext. This is useful when you need to generate unique passwords for Sisense MongoDB users.
Note: This endpoint is currently part of Sisense V6.7 beta and is subject to changes.
Parameters
Parameter
Description
Parameter Type
Data Type
plaintext
Your plaintext password generated by Sisense.
query
string
Error Status Codes
HTTP Status Code
Reason
200
Plaintext password was encrypted successfully
Status
colour
Green
title
post
/database/change_database_user_password
Expand
title
Change a MongoDB user’s password
Change a user’s password for the MongoDB installed with Sisense.
Note: This endpoint is currently part of Sisense V6.7 beta and is subject to changes.
Parameters
Parameter
Description
Parameter Type
Data Type
authorization
The user's API token, preceded by the keyword Bearer (with a space between it and the token). For more information, please refer to the API tutorial
header
string
User object
The User object that defines the user whose password is to be changed and the new password.
body
Enter the user name of the Sisense MongoDB user and a new password.
Array[string]
{ "userName": "string", "password": "string" }
Error Status Codes
HTTP Status Code
Reason
200
Password changed successfully
400
Invalid username
Datasets
Status
colour
Blue
title
GET
/datasets
Expand
title
Returns a list of data sets
The get datasets endpoint provides access to datasets in their stored format as JSON objects.
The expandable field for the data object is connection.
Parameters
Parameter
Description
Parameter Type
Data Type
authorization
The user's API token, preceded by the keyword Bearer (with a space between it and the token). For more information, please refer to the API tutorial
header
string
fields
Whitelist of fields to return for each document. fields can also define which fields to exclude by prefixing field names with -
query
Array[string]
Status
colour
Blue
title
GET
/datasets/{id}
Expand
title
Returns a dataset by ID
Theget datasetendpoint returns a dataset object by ID.
Parameters
Parameter
Description
Parameter Type
Data Type
authorization
The user's API token, preceded by the keyword Bearer (with a space between it and the token). For more information, please refer to the API tutorial
header
string
id
The ID of the live connection. You can retrieve this ID through the GET /datasets ID
query
Array[string]
Error Status Codes
HTTP Status Code
Reason
404
Dataset not found
Status
colour
Blue
title
GET
/datasets/{id}/transformed
Expand
title
Returns a modified dataset by ID
Theget datasetendpoint returns a dataset object with an applied schema transformation by ID.
Parameters
Parameter
Description
Parameter Type
Data Type
authorization
The user's API token, preceded by the keyword Bearer (with a space between it and the token). For more information, please refer to the API tutorial
header
string
id
The ID of the live connection. You can retrieve this ID through the GET /datasets ID
query
Array[string]
Error Status Codes
HTTP Status Code
Reason
404
Dataset not found
Status
colour
Blue
title
GET
/datasets/{id}/permissions
Expand
title
Returns the dataset permissions by its ID
Theget dataset permissionsendpoint returns the permissions for a dataset.
Parameters
Parameter
Description
Parameter Type
Data Type
authorization
The user's API token, preceded by the keyword Bearer (with a space between it and the token). For more information, please refer to the API tutorial
header
string
id
The ID of the live connection. You can retrieve this ID through the GET /datasets ID
query
Array[string]
Error Status Codes
HTTP Status Code
Reason
404
Dataset not found
Status
colour
Blue
title
GET
/datasets/by_fullname/{fullname}
Expand
title
Returns a dataset by its fullname
The get dataset by fullname endpoint returns a dataset object by its fullname property.
The expandable field for the dataset object is connection. The Expanded connection does not have a parameters property.
Parameters
Parameter
Description
Parameter Type
Data Type
fullname
The datasets fullname
header
string
expand
List of fields that should be expanded (substitutes their IDs with actual objects). May be nested using the resource.subResource format
query
Array[string]
Error Status Codes
HTTP Status Code
Reason
404
Dataset not found
Status
colour
Blue
title
GET
/datasets/{fullname}/datasecurity
Expand
title
Returns the data security rules set up for a dataset
Theget data securityendpoint returns the data security rules set up for a data set.
Parameters
Parameter
Description
Parameter Type
Data Type
authorization
The user's API token, preceded by the keyword Bearer (with a space between it and the token). For more information, please refer to the API tutorial
header
string
fullname
The datasets fullname
header
string
Error Status Codes
HTTP Status Code
Reason
404
Dataset not found
Status
colour
Green
title
post
/datasets/
Expand
title
Creates a new dataset
Thecreate datasetendpoint creates a new dataset object.
Parameters
Parameter
Description
Parameter Type
Data Type
authorization
The user's API token, preceded by the keyword Bearer (with a space between it and the token). For more information, please refer to the API tutorial
header
string
dataset
The dataset object that defines a dataset
body
Error Status Codes
HTTP Status Code
Reason
400
Bad request error.
23004 Name duplication error
23003 Connection not found
Status
colour
Green
title
post
/datasets/{fullname}/datasecurity
Expand
title
Defines data security rules for a dataset
Thecreate data contextendpoint creates new data context object.
Parameters
Parameter
Description
Parameter Type
Data Type
authorization
The user's API token, preceded by the keyword Bearer (with a space between it and the token). For more information, please refer to the API tutorial
header
string
fullname
The dataset’s fullname
path
string
dataCOntext
The data context object that defines a dataset’s permissions
body
Error Status Codes
HTTP Status Code
Reason
400
Bad request error.
30001 Invalid default rule
30003 Duplicate user or group
30004 User or group not found
404
Dataset not found
Status
colour
Yellow
title
patch
/datasets/{id}
Expand
title
Updates a specific dataset
Theupdate datasetendpoint updates a dataset with new data.
Parameters
Parameter
Description
Parameter Type
Data Type
authorization
The user's API token, preceded by the keyword Bearer (with a space between it and the token). For more information, please refer to the API tutorial
header
string
id
The dataset's ID. You can retrieve a dataset's ID through the GET /datasets endpoint
path
string
dataset
The dataset object that defines a dataset
body
Error Status Codes
HTTP Status Code
Reason
200
Updated dataset
400
Bad request error.
23001 Permission error
23003 Connection not found
23004 Name duplication error
404
Dataset not found
Status
colour
Yellow
title
patch
/datasets/{id}/permissions
Expand
title
Updates a specific dataset's permissions
Theupdate datasetendpoint updates the dataset with the fetched permissions.
Parameters
Parameter
Description
Parameter Type
Data Type
authorization
The user's API token, preceded by the keyword Bearer (with a space between it and the token). For more information, please refer to the API tutorial
header
string
id
The dataset's ID. You can retrieve a dataset's ID through the GET /datasets endpoint
path
string
permissions
The dataset object that defines a dataset
body
Error Status Codes
HTTP Status Code
Reason
400
Bad request error.
23001 Permission error
23005 User not found
23006 Group not found
404
Dataset not found
Status
colour
Red
title
delete
/datasets/{id}
Expand
title
Removes a data context by ID
Theremove datasetendpoint removes a dataset by ID.
Parameters
Parameter
Description
Parameter Type
Data Type
authorization
The user's API token, preceded by the keyword Bearer (with a space between it and the token). For more information, please refer to the API tutorial
header
string
id
The dataset's ID. You can retrieve a dataset's ID through the GET /datasets endpoint
path
string
Error Status Codes
HTTP Status Code
Reason
204
Dataset was successfully removed
400
Bad request error.
23001 Permission error
404
Dataset not found
Status
colour
Red
title
delete
/datasets/datasecurity/{dataSecurityId}
Expand
title
Removes data context object by ID
The remove data context endpoint removes the specified data context by its ID.
Parameters
Parameter
Description
Parameter Type
Data Type
authorization
The user's API token, preceded by the keyword Bearer (with a space between it and the token). For more information, please refer to the API tutorial
Verify connectivity between your ElastiCube server and an R server
The test R server endpoint verifies connectivity between an ElastiCube server and an R server.
Parameters
Parameter
Description
Parameter Type
Data Type
authorization
The user's API token, preceded by the keyword Bearer (with a space between it and the token). For more information, please refer to the API tutorial
header
string
server
The ElastiCube server’s address
path
string
rserver
The R server address
query
string
Error Status Codes
HTTP Status Code
Reason
403
Forbidden
500
Internal server error
Status
colour
Blue
title
GET
/elasticubes/servers/{server}/settings
Expand
title
Returns your ElastiCube server’s settings
The get server settings endpoint returns your ElastiCube server’s settings. For more information about the fields returned, see Server Settings.
Parameters
Parameter
Description
Parameter Type
Data Type
authorization
The user's API token, preceded by the keyword Bearer (with a space between it and the token). For more information, please refer to the API tutorial
header
string
server
The address of the ElastiCube server to return details for
path
string
Error Status Codes
HTTP Status Code
Reason
403
Forbidden
500
Internal server error
Status
colour
Green
title
post
/elasticubes/servers/{server}/settings
Expand
title
Updates your ElastiCube server’s settings
The post server settings endpoint updates the settings of your Elasticubes server. For more information, see Server Settings.
Parameters
Parameter
Description
Parameter Type
Data Type
authorization
The user's API token, preceded by the keyword Bearer (with a space between it and the token). For more information, please refer to the API tutorial
header
string
server
The ElastiCube server address
path
string
restart
Boolean that when true restarts the ElastiCubes on the server
query
boolean
serverSettings
The settings object to update
The following table contains a list of properties you can define in the serverSettings object:
Name
Description
DefaultDataDirectory
A string that defines the location of your ElastiCubes on your server. Sisense recommends storing ElastiCube data on a separate non-system drive.
ElasticubeMemoryAllocation
The percentage of RAM out of the server's total RAM on the machine that can be allocated to each ElastiCube. By default, the value is set to Dynamic, which automatically allocates and frees memory in each ElastiCube to ensure stability and performance. Setting a static percentage will disable this mechanism.
DataImportChunkSize
The size of each chunk of data imported when building an ElastiCube. This can be increased or decreased based on your build performance and network throughput.
SimultaneousQueryExecutions
The number of simultaneous queries that can be processed on a server across all ElastiCubes.
This value is determined by half of the machine's vCPU cores.
QueryTimeout
The amount of seconds that must pass before a query times out.
RecycleQueries
The ElastiCube Query Recycler caches similar and identical queries to the ElastiCube to reduce the amount of time to return a response. This reduces the amount of time it takes to process queries.
This should be turned off for debugging purposed only.
RserverEnabled
A boolean that defines if R Server is enabled in Sisense.
Rserver
The address of your R Server. By default, this field is not activated. Click the toggle button to enable the R server in Sisense and enter the IP address and port. Click Test to verify the connection to the R server.
body
Error Status Codes
HTTP Status Code
Reason
403
Forbidden
500
Internal Server Error
Status
colour
Green
title
post
/elasticubes/sets
Expand
title
Add ElastiCube Sets
The add ElastiCube Setendpoint receives a new ElastiCube Set object and creates that set in Sisense, returning the created object. If a server full name does not exist, an error will be returned.
Parameters
Parameter
Description
Parameter Type
Data Type
authorization
The user's API token, preceded by the keyword Bearer (with a space between it and the token). For more information, please refer to the API tutorial
header
string
set
Basic ElastiCube set object (in JSON notation) to be added
body
Error Status Codes
HTTP Status Code
Reason
400
22001 The 'fullNames' parameter must be an array
22002 The 'fullNames' parameter cannot be empty
22003 The ElastiCube set already exists
22004 One or more of the given ElastiCubes could not be found
22005 One or more of the given ElastiCubes are already part of the ElastiCube set
Status
colour
Green
title
post
/elasticubes/{elasticube}/jaql/explain
Expand
title
Explains the JAQL
The explain Jaql endpoint explains the jaql.
Parameters
Parameter
Description
Parameter Type
Data Type
authorization
The user's API token, preceded by the keyword Bearer (with a space between it and the token). For more information, please refer to the API tutorial
header
string
rowcount
Whether to include row count
query
boolean
uniquecount
Whether to include unique count
query
boolean
jaql
Jaql object to be explained
body
Error Status Codes
HTTP Status Code
Reason
400
22001 The 'fullNames' parameter must be an array
22002 The 'fullNames' parameter cannot be empty
22003 The ElastiCube set already exists
22004 One or more of the given ElastiCubes could not be found
22005 One or more of the given ElastiCubes are already part of the ElastiCube set
Status
colour
Green
title
post
/elasticubes/{server}/{title}/custom_tables
Expand
title
Creates a custom table
The post custom tables endpoint creates a custom table on an ElastiCube through an SQL query.
Parameters
Parameter
Description
Parameter Type
Data Type
authorization
The user's API token, preceded by the keyword Bearer (with a space between it and the token). For more information, please refer to the API tutorial
header
string
server
The server of the ElastiCube where the custom table is to be created
path
string
title
The title of the ElastiCube where the custom table is to be created
path
string
tableSqlQuery
The tableSqlQuery object that defines the SQL query that creates a table and the name of the custom table
body
Error Status Codes
HTTP Status Code
Reason
403
Forbidden
500
Internal server error
Status
colour
Green
title
post
/elasticubes/{server}/{title}/sql_manual_query
Expand
title
Creates an SQL query
The post sql manual query endpoint creates an SQL query on an ElastiCube.
Parameters
Parameter
Description
Parameter Type
Data Type
authorization
The user's API token, preceded by the keyword Bearer (with a space between it and the token). For more information, please refer to the API tutorial
header
string
server
The server of the ElastiCube where the custom table is to be created
path
string
title
The title of the ElastiCube where the custom table is to be created
path
string
manualTableSqlQuery
The manualTableSqlQuery object that defines the SQL query that creates a table and the name of the new table
The delete custom field endpoint deletes the SQL query that creates a custom field removing the field from the table.
Parameters
Parameter
Description
Parameter Type
Data Type
authorization
The user's API token, preceded by the keyword Bearer (with a space between it and the token). For more information, please refer to the API tutorial
header
string
server
The server of the ElastiCube where the custom field is to be deleted
path
string
title
The title of the ElastiCube where the custom field is to be deleted
path
string
tableName
The title of the table where the custom field is to be deleted
path
string
fieldName
The title of the table filed to get
Error Status Codes
HTTP Status Code
Reason
403
Forbidden
500
Internal Server Error
Engine
Status
colour
Green
title
post
/engine/excelExport
Expand
title
Export Excel files
Note: This endpoint is not available from Sisense’s interactive REST API.
The /engine/excelExport endpoint returns the binary content of the xlsx file. The user should then create an Excel file from this content just like any other stream.
METHOD:
POST
PARAMS:
query: This endpoint requires a pivot JAQL and returns it as an Excel file.
Example:
The code sample below returns the binary content of an xlsx file and converts it to an Excel file.
The conditional in the sample below creates an xlsx file in Internet Explorer 11, or in Chrome or FireFox for non-IE browsers.
$http.post('/engine/excelExport',{query:query},{
responseType:'blob',
})
.then(function(res){
$scope.isLoaded = true;
// IE11 and older fix because they have bug with createObjectURL
if (window.navigator.msSaveBlob){
window.navigator.msSaveBlob(res.data,fileName);
}else{
var blob = new Blob([res.data],{type:'application/vnd.openxmlformats-officedocument.spreadsheetml.sheet'});
var blobURL = window.URL.createObjectURL(blob);
var a = document.createElement('a');
a.href = blobURL;
a.download = fileName;
document.body.appendChild(a);
a.click();
window.URL.revokeObjectURL(blobURL);
document.body.removeChild(a);
}
})
Features
Status
colour
Blue
title
GET
/features
Expand
title
Return a list of features
The /features endpoint returns a list of features you can enable/disbale.
Parameters
Parameter
Description
Data Type
authorization
The user's API token, preceded by the keyword Bearer (with a space between it and the token). For more information, please refer to the API tutorial
string
key
Name of the feature. You can use the values returned in this array to enable/disable features.
string
active
Status of the feature, enabled or disabled.
boolean
name
Name of the feature.
string
description
Description of the feature.
string
subscriptions
Array that contains specific functionality that can be enabled/disabled in a feature. For example, in the Alerting feature build alerts and KPI alerts can be enabled or disabled.
array
name
Name of the functionality within a feature that can be enabled or disabled, for example, buildSubscription or kpiSubscription.
array
active
Status of the feature, enabled or disabled.
boolean
Status
colour
Yellow
title
patch
/features/{key}/toggle
Expand
title
Toogles a feature on or off
The toggle endpoint turns a specific feature on or off.
Parameters
Parameter
Description
Parameter Type
Data Type
authorization
The user's API token, preceded by the keyword Bearer (with a space between it and the token). For more information, please refer to the API tutorial
header
string
key
The ID of the dashboard to delete
path
string
toggleFeature
Indicates if the feature should be enabled or disabled.
path
boolean
Error Status Codes
HTTP Status Code
Reason
404
Feature not found
Folders
Status
colour
Blue
title
GET
/folders
Get all folders
Status
colour
Blue
title
GET
/folders/{id}
Get a specific folder
Status
colour
Blue
title
GET
/folders/{id}/subtree
Get a subtree of a specific folder
Status
colour
Blue
title
GET
/folders/{id}/ancestors
Get the ancestors of a specific folder
Status
colour
Green
title
post
/folders
Add a new folder
Status
colour
Yellow
title
patch
/folders/{id}
Update a folder
Status
colour
Red
title
delete
/folders/{id}
Delete a folder
Geo
Status
colour
Blue
title
GET
/geo/geoJson/{type}
Expand
title
Gets the coordinates of countries or states
The get /geo/geoJson/{type} endpoint returns an array of coordinates for US states or countries.
Parameters
Parameter
Description
Parameter Type
Data Type
type
Accepts two possible values, world or usa. Returns the coordinates of US states or countries.
The get groups endpoint returns a list of user groups with their details. The results can be filtered by different parameters such as group name or origin.
The expandable fields for the group object are users and role.
Parameters
Parameter
Description
Parameter Type
Data Type
name
Group name to filter by
query
string
mail
Group email to filter by
query
string
roleId
Group role ID to filter by
query
string
origin
Group origin to filter by (ad or sisense)
query
string
ids
Group IDs to filter by, separated by a comma (,) and without spaces
query
array
fields
Whitelist of fields to return for each document. Can also define which fields to exclude by prefixing field names with -
query
string
sort
Field by which the results should be sorted. Ascending by default, descending if prefixed by -
query
string
skip
Number of results to skip from the start of the data set. To be used with the limit parameter for paging
query
integer
limit
How many results should be returned. To be used with the skip parameter for paging
query
integer
expand
List of fields that should be expanded (substitutes their IDs with actual objects). May be nested using the resource.subResource format
The get LDAP domains endpoint returns a list of ldapDomains with their details. Results can be filtered by parameters such as name and enabled.
The expandable field for the LDAP domain object is users.
Parameters
Parameter
Description
Parameter Type
Data Type
authorization
The user's API token, preceded by the keyword Bearer (with a space between it and the token). For more information,please refer to the API tutorial
header
string
name
Name to filter the LDAP domains returned by.
query
string
enabled
Filter LDAP domains according to their status enabled or disabled.
query
boolean
ids
Array of LDAP domains IDs to get, separated by a comma (,) and without spaces.
query
Array[string]
fields
Whitelist of fields to return for each document. fields Can also define which fields to exclude by prefixing field names with -.
query
string
sort
Field by which the results should be sorted. Ascending by default, descending if prefixed by -.
query
string
skip
Number of results to skip from the start of the data set. skip is to be used with the limit parameter for paging.
query
number
limit
How many results should be returned. limit is to be used with the skip parameter for paging.
query
number
expand
List of fields that should be expanded (substitures their IDs with actual objects). May be nested using the resource.subResource format.
query
string
Error Status Codes
HTTP Status Code
Reason
404
Invalid expand parameter.
Status
colour
Blue
title
GET
/ldap_domains/{id}
Expand
title
Get a specific LDAP domain
The get LDAP domain by ID endpoint retrieves a specific LDAP domain object corresponding to the provided ID. The expandable fields for the LDAP domain object is users.
Parameters
Parameter
Description
Parameter Type
Data Type
authorization
The user's API token, preceded by the keyword Bearer (with a space between it and the token). For more information,please refer to the API tutorial
header
string
id
The ID of the LDAP domain to get.
query
string
fields
Whitelist of fields to return for each document. fields Can also define which fields to exclude by prefixing field names with -.
query
string
expand
List of fields that should be expanded (substitures their IDs with actual objects). May be nested using the resource.subResource format.
query
string
Error Status Codes
HTTP Status Code
Reason
404
202 Invalid expand parameter.
22001 LDAP domain not found.
Status
colour
Green
title
POST
/ldap_domains
Expand
title
Add a new LDAP Domain
The add LDAP Domain endpoint receives a new LDAP Domain object and creates that domain in Sisense, returning the created object.
If a domain with the same name or baseDN exists, Sisense returns an error.
Parameters
Parameter
Description
Parameter Type
Data Type
authorization
The user's API token, preceded by the keyword Bearer (with a space between it and the token). For more information,please refer to the API tutorial
header
string
ldapDomain
Basic LDAP domain object (in JSON notation) to be added.
body
object
Error Status Codes
HTTP Status Code
Reason
400
2004 The user already exists.
2006 Multiple super-users are not allowed.
2007 Cannot add user because the license has been exceeded.
2009 Mandatory fields cannot be empty.
422
601 Invalid object ID.
2003 Mandatory fields are missing.
Status
colour
Green
title
POST
/ldap_domains/test
Expand
title
Test LDAP Domain
The test LDAP Domain endpoint receives an LDAP Domain object and tests it against the LDAP server.
If the LDAP server is not responding/wrong credentials were sent, Sisense will return an error.
Parameters
Parameter
Description
Parameter Type
Data Type
authorization
The user's API token, preceded by the keyword Bearer (with a space between it and the token). For more information,please refer to the API tutorial
header
string
ldapDomain
Basic LDAP domain object (in JSON notation) to be added.
body
object
Error Status Codes
HTTP Status Code
Reason
204
No response was specified
Status
colour
Green
title
POST
/ldap_domains/{id}/sync
Expand
title
Sync LDAP Domain
The sync LDAP Domain endpoint receives an LDAP Domain ID and synchronize it against the LDAP server.
If a the LDAP server is not responding, Sisense will return an error.
Parameters
Parameter
Description
Parameter Type
Data Type
authorization
The user's API token, preceded by the keyword Bearer (with a space between it and the token). For more information,please refer to the API tutorial
header
string
id
The ID of the domain to update
path
string
wait
Sisense should wait to sync the LDAP domain.
query
boolean
Error Status Codes
HTTP Status Code
Reason
204
No response was specified
Status
colour
Yellow
title
patch
/ldap_domains/{id}
Expand
title
Update a LDAP domain
The update LDAP Domain endpoint receives a domain id and what fields to update, returning the updated object.
If a domain with the specified id is not exists, Sisense returns an error.
Parameters
Parameter
Description
Parameter Type
Data Type
authorization
The user's API token, preceded by the keyword Bearer (with a space between it and the token). For more information,please refer to the API tutorial
header
string
id
The ID of the LDAP domain to update.
path
string
fields
Partial LDAP Domain object (in JSON notation) containing the fields to update
body
object
Error Status Codes
HTTP Status Code
Reason
404
2001 User not found.
Status
colour
Red
title
DELETE
/ldap_domains/bulk
Expand
title
Delete LDAP domains
The delete LDAP Domains endpoint receives a list of domain IDs and deletes these domains in Sisense.
If a domain with the specified id does not exists, Sisense returns an error.
Parameters
Parameter
Description
Parameter Type
Data Type
authorization
The user's API token, preceded by the keyword Bearer (with a space between it and the token). For more information,please refer to the API tutorial
header
string
id
Array of LDAP domain IDs to delete, separated by a comma (,) and without spaces.
query
Array[string]
Error Status Codes
HTTP Status Code
Reason
204
No response was specified
404
22001 One or more LDAP domains were not found.
Live Connectors
Status
colour
Blue
title
GET
/live_connectors
Expand
title
Returns the list of available live connector services
The get live connectors endpoint returns a list of connectors.
Parameter
Description
Parameter Type
Data Type
authorization
The user's API token, preceded by the keyword Bearer (with a space between it and the token). For more information,please refer to the API tutorial
header
string
Error Status Codes
HTTP Status Code
Reason
404
API not found
Status
colour
Blue
title
GET
/live_connectors/{provider}
Expand
title
Returns object that describes the connection manifest (parameters)
The get live connectors endpoint returns a list of connectors.
Parameter
Description
Parameter Type
Data Type
authorization
The user's API token, preceded by the keyword Bearer (with a space between it and the token). For more information,please refer to the API tutorial
header
string
provider
The name of live connector provider
path
string
Error Status Codes
HTTP Status Code
Reason
404
API not found
Status
colour
Green
title
POST
/live_connectors/{provider}/count
Expand
title
Returns count of entries in table
The get table count endpoint returns the number of entries in a specified table.
Parameter
Description
Parameter Type
Data Type
authorization
The user's API token, preceded by the keyword Bearer (with a space between it and the token). For more information,please refer to the API tutorial
header
string
provider
The name of live connector provider
path
string
connectionParameters
The connection parameters for a specific datasource
body
Error Status Codes
HTTP Status Code
Reason
404
API not found
Status
colour
Green
title
POST
/live_connectors/{provider}/table_preview
Expand
title
Returns data preview
The get table preview endpoint returns a preview of the data in specified table.
Parameter
Description
Parameter Type
Data Type
authorization
The user's API token, preceded by the keyword Bearer (with a space between it and the token). For more information,please refer to the API tutorial
header
string
provider
The name of live connector provider
path
string
connectionParameters
The connection parameters for a specific datasource
body
Error Status Codes
HTTP Status Code
Reason
404
API not found
Status
colour
Green
title
POST
/live_connectors/{provider}/list_databases
Expand
title
Returns list of databases
The list databases endpoint returns a list of available databases in the connected instance.
Parameter
Description
Parameter Type
Data Type
authorization
The user's API token, preceded by the keyword Bearer (with a space between it and the token). For more information,please refer to the API tutorial
header
string
provider
The name of live connector provider
path
string
connectionParameters
The connection parameters for a specific datasource
body
Error Status Codes
HTTP Status Code
Reason
404
API not found
Status
colour
Green
title
POST
/live_connectors/{provider}/test_connection
Expand
title
Returns an object with status = OK after a successful connection
The test_connection endpoint Opens a connection through a specified connector to the datasource.
Parameter
Description
Parameter Type
Data Type
authorization
The user's API token, preceded by the keyword Bearer (with a space between it and the token). For more information,please refer to the API tutorial
header
string
provider
The name of live connector provider
path
string
connectionParameters
The connection parameters for a specific datasource
body
Error Status Codes
HTTP Status Code
Reason
404
API not found
Status
colour
Green
title
POST
/live_connectors/{provider}/list_table_schemas
Expand
title
Returns a list of tables in a database
The list table schemas endpoint returns a list of available tables in a specified database. Table schemas do not include column details.
Parameter
Description
Parameter Type
Data Type
authorization
The user's API token, preceded by the keyword Bearer (with a space between it and the token). For more information,please refer to the API tutorial
header
string
provider
The name of live connector provider
path
string
connectionParameters
The connection parameters for a specific datasource
body
Error Status Codes
HTTP Status Code
Reason
404
API not found
Status
colour
Green
title
POST
/live_connectors/{provider}/table_schema_details
Expand
title
Returns a table's schema
The list table schemas endpoint returns a list of available tables in a specified database. Table schemas do not include column details.
Parameter
Description
Parameter Type
Data Type
authorization
The user's API token, preceded by the keyword Bearer (with a space between it and the token). For more information,please refer to the API tutorial
header
string
provider
The name of live connector provider
path
string
connectionParameters
The connection parameters for a specific datasource
body
Error Status Codes
HTTP Status Code
Reason
404
API not found
Logs
Status
colour
Green
title
POST
/logs/timer
Expand
title
Returns a table's schema
The post timer endpoint returns information regarding your dashboard’s loading times.
Narration
Status
colour
Blue
title
GET
/narration/token
Expand
title
Returns a table's schema
The token endpoint is used for getting a new token for widget narration. With this token, you can enable widget narration if this feature is enabled for your account.
Note: This endpoint is currently part of Sisense V6.7 beta and is subject to changes. Error Status Codes
HTTP Status Code
Reason
401
Not allowed to retrieve a token
404
Not found
Status
colour
Green
title
POST
/narration/widget
Expand
title
Define narrated text
The narration/widget endpoints defines custom narration for a widget
Note: This endpoint is currently part of Sisense V6.7 beta and is subject to changes.
Parameter
Description
Parameter Type
Data Type
authorization
The user's API token, preceded by the keyword Bearer (with a space between it and the token). For more information,please refer to the API tutorial
header
string
narrationParameters
The narration object that defines how a widget is narrated.
Name
Type
Mandatory
Description
charttype
string
Yes
The type of widget, chart, pie, etc.
widgetId
string
No
The ID of the widget where the custom text is to be applied to
dashboardId
string
No
The dashboard ID where the widget is located
format
string
No
The format of the text, bullets or paragraph ['bullets', 'paragraph']
verbosity
string
No
The amount of text to be included in the narration ['high, 'medium', 'low']
up_sentiment
string
No
The narration text sentiment
['good', 'bad'],
aggregation
string
No
The
narration text aggregation
['sum', 'average']
datasource
string
No
format
string
No
isMaskedResult
string
No
count
number
No
offset
number
No
format
string
No
The format of the data
field
string
No
dim
string
No
datatype
string
No
title
string
No
id
string
No
index
number
No
aggregation (string, optional):
narration text aggregation
= ['sum', 'average']
datasource (string,object),
format (string, optional):
data format
,
isMaskedResult (boolean, optional):
masked result check
,
count (number, optional):
narration text
,
offset (number, optional):
offset
path
string
Error Status Codes
HTTP Status Code
Reason
401
Not authorized to access this endpoint
404
57007 Chart type not supported 57008 Data not supported for narration
422
300 Invalid request data 57003 Invalid JAQL request 57004 Can not handle JAQL response 57006 Narration error request
504
Gateway Timeout
Oauth
Status
colour
Blue
title
GET
/oauth/{service}/login_uri
Expand
title
Returns basic redirect url for OAuth login endpoint
The get login uri endpoint returns uri for service login without redirect_uri param. It should be generated at client side.
Parameter
Description
Parameter Type
Data Type
authorization
The user's API token, preceded by the keyword Bearer (with a space between it and the token). For more information,please refer to the API tutorial
header
string
service
The name of service
path
string
Error Status Codes
HTTP Status Code
Reason
404
API not found
Status
colour
Green
title
POST
/oauth/{service}/auth
Expand
title
Returns tokens needed for oauth
The authorize endpoint returns tokens for specific client code.
Parameter
Description
Parameter Type
Data Type
authorization
The user's API token, preceded by the keyword Bearer (with a space between it and the token). For more information,please refer to the API tutorial
header
string
service
The name of service
path
string
body
Contains code and redirectUri parameters
body
Error Status Codes
HTTP Status Code
Reason
404
API not found
Plugins
Status
colour
Blue
title
GET
/plugins
Expand
title
Return a list of your plug-ins
The get plugins endpoint returns a list of plugins with their details according to the filters and ordering you define.
The following information is returned:
Name
Type
Mandatory
Description
count
number
No
The amount of plug-ins enabled and disabled
name
string
No
Your plug-in's name
version
string, number
No
The version of the plug-in. Description of the plug-in and its version number
lastUpdated
string
No
The last time the plug-in was updated
isEnabled
boolean
No
Describes the current status of your plug-in, enabled/disabled
folderName
string
No
The folder name of the plug-in
limit
number
No
The limit defined for the amount of items that can be returned
skip
number
No
The number of items to be skipped before returning the remaining items
search
string
No
Any search terms that were defined in the request
orderby
string
No
The order in which the results were returned
desc
boolean
No
A boolean value that determines how the results were returned, ascending/descending
Note: This endpoint is currently part of Sisense V6.7 beta and is subject to changes.
Parameters
Parameter
Description
Parameter Type
Data Type
authorization
The user's API token, preceded by the keyword Bearer (with a space between it and the token). For more information,please refer to the API tutorial
header
string
orderby
Filter by the field defined here
query
string
desc
Order by descending/ascending. The order is descending when this value is true. The order is ascending when this value is false
query
boolean
search
List of fields that should be expanded (substitutes their IDs with actual objects). May be nested using the resource.subResource format
query
string
skip
Number of results to skip from the start of the data set. skip is to be used with the limitparameter for paging
query
string
limit
How many results should be returned. limit is to be used with the skip parameter for paging
query
string
Error Status Codes
HTTP Status Code
Reason
404
Invalid parameter
Status
colour
Blue
title
GET
/plugins/get_info
Expand
title
Return the plug-in’s build information
The get_info endpoint returns the build information including the JavaScript file name and last build error.
Note: This endpoint is currently part of Sisense V6.7 beta and is subject to changes.
Parameter
Description
Parameter Type
Data Type
authorization
The user's API token, preceded by the keyword Bearer (with a space between it and the token). For more information,please refer to the API tutorial
header
string
returnFile
Determines if the response is returned in JavaScript format or JSON.
query
boolean
Error Status Codes
HTTP Status Code
Reason
200
No response was specified
Status
colour
Yellow
title
patch
/plugins
Expand
title
Update your plug-in’s metadata
The put plugins endpoint updates the metadata of a plug-in and returns a list of modified plug-ins. Metadata for a plug-in includes its filename, directory location, and version details.
Note: This endpoint is currently part of Sisense V6.7 beta and is subject to changes.
Parameter
Description
Parameter Type
Data Type
authorization
The user's API token, preceded by the keyword Bearer (with a space between it and the token). For more information,please refer to the API tutorial
header
string
plugins
plugins array to be updated
You can update the following:
Parameter
Type
Mandatory
Description
name
string
No
The plug-in's name
version
string
No
The plug-in's version
lastUpdate
string
No
Last time the plug-in was updated
isEnabled
boolean
No
Whether the plug-in is enabled or disabled
folderName
string
No
The plug-in's folder name
body
Array[undefined]
Error Status Codes
HTTP Status Code
Reason
202
Plug-ins updated successfully
404
No plugins updated
Reporting
Status
colour
Green
title
POST
/reporting
Expand
title
Send an email report
The send report endpoint receives asset info and recipients list and sends an email report. Note: the users and groups in the recipients section must be shared to the dashboard.
Parameters
Parameter
Description
Parameter Type
Data Type
authorization
The user's API token, preceded by the keyword Bearer (with a space between it and the token). For more information,please refer to the API tutorial
header
string
reportObject
An object containing the data needed in order to send the report. AssetId being the dashboard ID and the recipients array should contain the user's/group's ID along with its type. The preferences section describes the content of the Email to be sent.
Whitelist of fields to return for each document. You can also define which fields to exclude by prefixing field names with -
query
string
expand
List of fields that should be expanded (substitutes their IDs with actual objects). May be nested using the resource.subResource format
query
string
Error Status Codes
HTTP Status Code
Reason
204
Send report operation was successful
Settings
Status
colour
Blue
title
GET
/settings/sso
Expand
title
Returns SSO settings
The sso settings used for single sign on configuration.
Error Status Codes
HTTP Status Code
Reason
403
Forbidden
404
Name not found
Status
colour
Blue
title
GET
/settings/system
Expand
title
Returns system configuration settings
The system settings used for system settings configuration.
Error Status Codes
HTTP Status Code
Reason
400
System settings are empty
403
Forbidden
404
Name not found
Status
colour
Blue
title
GET
/settings/email_server
Expand
title
Return email server settings
The email server settings used for Email Server settings managing.
Error Status Codes
HTTP Status Code
Reason
404
Email server does not exist
Status
colour
Blue
title
GET
/settings/globalization
Expand
title
Returns globalization settings
The globalization endpoint returns locale settings, including the set locale, and whether autodetect is enabled.
Parameter
Description
Parameter Type
Data Type
authorization
The user's API token, preceded by the keyword Bearer (with a space between it and the token). For more information,please refer to the API tutorial
header
string
Error Status Codes
HTTP Status Code
Reason
404
Not configured yet
Status
colour
Blue
title
GET
/settings/public_settings
Expand
title
Return public configuration settings
The Public Configuration used for getting public system settings.
Status
colour
Green
title
POST
/settings/sso
Expand
title
Set SSO settings
The sso settings used for single sign on configuration.
Parameter
Description
Parameter Type
Data Type
authorization
The user's API token, preceded by the keyword Bearer (with a space between it and the token). For more information,please refer to the API tutorial
header
string
sso
Object with the SSO settings.
You can define the following attributes:
"_id": An ID generated by Sisense. You can retrieve this through the GET /settings/sso endpoint.
"name": The name of the object defined by Sisense. By default, the name is sso.
"enabled": Boolean value that determines if SSO is enabled or not.
"ssoType": The type of SSO to be enabled, “jwt” or “saml”.
"loginUrl": The URL where users are redirected to when logging in when SSO via JWT is enabled.
"logoutUrl": The URL where users are redirected to when logging out when SSO via JWT is enabled.
"sharedSecret": Your shared secret key. The Shared Key is a JWT encryption public key used to encrypt the JWT payload. It is generated when the SSO configuration is saved in the Sisense Web Application.
"loginUrlSaml": The URL where users are redirected to when logging in when SSO via SAML is enabled.
"logoutUrlSaml": The URL where users are redirected to when logging out when SSO via SAML is enabled.
"idPCert": A certificate provided by your IdP that enables Sisense to decrypt SAML responses from the IdP.
"lowSecurityJwtSso": A boolean that determines the level of security enforced when implementing SSO JWT security. By default, this value is False, which means the JTI parameter is required. The JTI parameter is a unique string added to the token that is used to prevent replay attacks, by making sure the token is used only once.
"syncGroupsFromSamlToken": A boolean that controls whether to update the user’s groups from the SAML SSO token on subsequent logins, and not created from scratch.
body
Error Status Codes
HTTP Status Code
Reason
400
Invalid input
403
Forbidden
Status
colour
Green
title
POST
/settings/system
Expand
title
Adds or updates system settings
The system settings used for system settings configuration.
Parameter
Description
Parameter Type
Data Type
authorization
The user's API token, preceded by the keyword Bearer (with a space between it and the token). For more information,please refer to the API tutorial
header
string
emailServer
Object with the system settings
body
Error Status Codes
HTTP Status Code
Reason
400
Invalid input
403
Forbidden
Status
colour
Green
title
POST
/settings/email_server
Expand
title
Add email server settings
The email server settings used for Email Server settings managing.
Parameter
Description
Parameter Type
Data Type
authorization
The user's API token, preceded by the keyword Bearer (with a space between it and the token). For more information,please refer to the API tutorial
header
string
emailServer
Object with the system settings
body
Error Status Codes
HTTP Status Code
Reason
400
7501 Email server settings already exists
Status
colour
Green
title
POST
/settings/globalization
Expand
title
Add globalization settings
You can change the locale or select whether the localization selection is automatically detected or not.
Parameter
Description
Parameter Type
Data Type
authorization
The user's API token, preceded by the keyword Bearer (with a space between it and the token). For more information,please refer to the API tutorial
header
string
globalization
Object with the globalization settings.
body
Error Status Codes
HTTP Status Code
Reason
400
Invalid input
403
Forbidden
Status
colour
Yellow
title
put
/settings/globalization
Expand
title
Update globalization settings
You can update the locale or select whether the localization selection is automatically detected or not.
Parameter
Description
Parameter Type
Data Type
authorization
The user's API token, preceded by the keyword Bearer (with a space between it and the token). For more information,please refer to the API tutorial
header
string
globalization
Object with the globalization settings.
body
Error Status Codes
HTTP Status Code
Reason
400
Invalid input
403
Forbidden
Status
colour
Yellow
title
patch
/settings/email_server
Expand
title
Update email server settings
The email server settings used for Email Server settings managing.
Parameter
Description
Parameter Type
Data Type
authorization
The user's API token, preceded by the keyword Bearer (with a space between it and the token). For more information,please refer to the API tutorial
header
string
emailServer
Object with the settings of email server
body
Error Status Codes
HTTP Status Code
Reason
400
Invalid input
403
Forbidden
Status
colour
Red
title
DELETE
/settings/email_server
Expand
title
Delete email server settings
The deleteemail server settings delete your email server settings.
Status
colour
Red
title
DELETE
/settings/globalization
Expand
title
Delete globalization settings
Deletes globalization settings in your server.
Parameter
Description
Parameter Type
Data Type
authorization
The user's API token, preceded by the keyword Bearer (with a space between it and the token). For more information,please refer to the API tutorial
header
string
Error Status Codes
HTTP Status Code
Reason
400
Invalid input
403
Not configured yet
Shares
Status
colour
Blue
title
GET
/dashboards/{dashboardId}/shares
Expand
title
Get a dashboard's shares
The get shares endpoint returns a dashboard's share configurations.
The expandable fields for the shares object are group and user.
Parameters
Parameter
Description
Parameter Type
Data Type
authorization
The user's API token, preceded by the keyword Bearer (with a space between it and the token). For more information, please refer to the API tutorial
header
string
dashboardId
The ID of the dashboard who's shares to get.
path
string
fields
Whitelist of fields to return for each document. Can also define which fields to exclude by prefixing field names with -
query
string
expand
List of fields that should be expanded (substitutes their IDs with actual objects). May be nested using the resource.subResource format
The suggestions status endpoint returns the current status of your suggestions including the last time your suggestions were updated.
lastExecution: The time of the last suggestion refresh.
jobStatus: Describes if the suggestions are to be refreshed or not.
jobFrequent: Describes when and how often the system is refreshed in CRON format.
executionStatus: Describes if the suggestions are currently being refreshed by the system. }
Note: This endpoint is available from Sisense V7.0 and later.
Error Status Codes
HTTP Status Code
Reason
404
Suggestion was not set
Status
colour
Green
title
POST
/suggestions
Expand
title
Returns suggestions for an entity
The suggestions endpoint allows you to leverage Sisense suggestions in your own application.
Note: This endpoint is available from Sisense V7.0 and later.
Parameters
Parameter
Description
Parameter Type
Data Type
authorization
The user's API token, preceded by the keyword Bearer (with a space between it and the token). For more information, please refer to the API tutorial
header
string
Suggestions Parameters
The properties that define which object to return suggestions for. You can return suggestions for a data source or for a specific field within a data source.
The request body includes the following properties:
Name
Mandatory
Description
datasource
Required
This object defines the source where the suggestions are pulled. { title: 'DATASOURCE_TITLE', (required) fullname: 'DATASOURCE_FULL_NAME' (optional) }
type
Required
A string that defines the type of suggestions (widgets, filters, forumlas etc.). Currently, the only value for this property is widgets.
count
Optional
A Number that defines how many items to return. By default 0.
fields
Required
This array contains a list of target fields (dimensions). [ { dim: 'FIELD_DIM' } ]
skip
Optional
A Number that defines how many items to skip. By default 0.
popular
Optional
A boolean that determines if popular fields are returned in the suggestions. By default this value is false.
body
Error Status Codes
HTTP Status Code
Reason
401
No access allowed
Status
colour
Green
title
POST
/suggestions/refresh
Expand
title
Refresh suggestions data and ranking
The suggestions refresh endpoint manually refreshes your suggestions with the latest data from your ElastiCube. Sisense automatically refreshes the data and rank once a day; however, you can refresh more often manually through this endpoint.
Note: This endpoint is available from Sisense V7.0 and later.
Parameters
Parameter
Description
Parameter Type
Data Type
authorization
The user's API token, preceded by the keyword Bearer (with a space between it and the token). For more information, please refer to the API tutorial
header
string
Suggestions Parameters
You can refresh your data and your suggestions’ ranking by setting the following properties to true.
You can refresh one or both properties.
"data": Boolean - If true, Sisense refreshes your suggestions data. "ranking": Boolean - If true, Sisense refreshes the ranking for results returned based. If you set data to true, Sisense refrshes your data to the latest data available and then refreshes the ranking. If you only set ranking to true, Sisense refreshes the ranking according to the existing data.
body
Error Status Codes
HTTP Status Code
Reason
401
No access allowed
404
Not found
Translations
Status
colour
Blue
title
GET
/translations
Expand
title
Return all supported languages
The get translations endpoint returns a list of all your supported languages in Sisense.
Parameters
Parameter
Description
Parameter Type
Data Type
authorization
The user's API token, preceded by the keyword Bearer (with a space between it and the token). For more information, please refer to the API tutorial
header
string
Error Status Codes
HTTP Status Code
Reason
404
Language not found
Status
colour
Blue
title
GET
/translations/{lang}
Expand
title
Return a language file
The get translationslanguagendpoint returns a language file.
Parameters
Parameter
Description
Parameter Type
Data Type
authorization
The user's API token, preceded by the keyword Bearer (with a space between it and the token). For more information, please refer to the API tutorial
header
string
Error Status Codes
HTTP Status Code
Reason
404
Language not found
Users
Status
colour
Blue
title
GET
/users
Expand
title
Get users
The get users endpoint returns a list of users with their details. Results can be filtered by parameters such as username and email.
The expandable fields for the user object are groups, adgroups and role.
Parameters
Parameter
Description
Parameter Type
Data Type
authorization
The user's API token, preceded by the keyword Bearer (with a space between it and the token). For more information, please refer to the API tutorial
header
string
userName
Username to filter by
query
string
email
Email to filter by
query
string
firstName
First name to filter by
query
string
lastName
Last name to filter by
query
string
roleId
Role ID to filter by
query
string
groupId
Group ID to filter by
query
string
active
User state to filter by - true for active users, false for inactive users
query
boolean
origin
User origin to filter by - ad for active directory or sisense
query
string
ids
Array of user IDs to get, separated by a comma (,) and without spaces
query
array
fields
Whitelist of fields to return for each document. Can also define which fields to exclude by prefixing field names with -
query
string
sort
Field by which the results should be sorted. Ascending by default, descending if prefixed by -
query
string
skip
Number of results to skip from the start of the data set. To be used with the limit parameter for paging
query
integer
limit
How many results should be returned. To be used with the skip parameter for paging
query
integer
expand
List of fields that should be expanded (substitutes their IDs with actual objects). May be nested using the resource.subResource format
The add user endpoint receives a new user object and creates that user in Sisense, returning the created object. If a user with the same username or email exists, it will return an error.
Parameters
Parameter
Description
Parameter Type
Data Type
authorization
The user's API token, preceded by the keyword Bearer (with a space between it and the token). For more information, please refer to the API tutorial
The bulk add endpoint allows adding multiple users at once, by receiving an array of user objects who's structure is alike to the single add user endpoint.
Parameters
Parameter
Description
Parameter Type
Data Type
authorization
The user's API token, preceded by the keyword Bearer (with a space between it and the token). For more information, please refer to the API tutorial
header
string
users
A collection of basic user objects (in JSON notation) to be added
The bulk add AD user endpoint receives an array of AD user objects, retrieves the user's details from Active Directory and adds them to the application.
Parameters
Parameter
Description
Parameter Type
Data Type
authorization
The user's API token, preceded by the keyword Bearer (with a space between it and the token). For more information, please refer to the API tutorial
The get dashboard widgets endpoint returns an array of a dashboard's widgets. The result can be filtered by different parameters such as the widget type or title.
Parameters
Parameter
Description
Parameter Type
Data Type
authorization
The user's API token, preceded by the keyword Bearer (with a space between it and the token). For more information, please refer to the API tutorial
header
string
dashboardId
The ID of the dashboard to get
path
string
title
Widget title to filter by
query
string
type
Widget type to filter by
query
string
subtype
Widget sub-type to filter by
query
string
fields
Whitelist of fields to return for each document. Can also define which fields to exclude by prefixing field names with -
query
string
sort
Field by which the results should be sorted. Ascending by default, descending if prefixed by -
query
string
skip
Number of results to skip from the start of the data set. To be used with the limit parameter for paging
query
integer
limit
How many results should be returned. To be used with the skip parameter for paging
The export widget to .png endpoint returns a specified widget rendered as a .png image. The desired output image size (height & width) must be specified.
Parameters
Parameter
Description
Parameter Type
Data Type
authorization
The user's API token, preceded by the keyword Bearer (with a space between it and the token). For more information, please refer to the API tutorial
header
string
dashboardId
The ID of the dashboard containing the widget
path
string
id
The ID of the widget to export
path
string
width
Render width in pixels
query
string
height
Render height in pixels
query
string
Error Status Codes
HTTP Status Code
Reason
200
Image file
Status
colour
Green
title
POST
/dashboards/{dashboardId}/widgets
Expand
title
Add a new widget to a dashboard
The add widget to dashboard endpoint adds the provided widget object to the dashboard of the given ID.
Parameters
Parameter
Description
Parameter Type
Data Type
authorization
The user's API token, preceded by the keyword Bearer (with a space between it and the token). For more information, please refer to the API tutorial
The update widget endpoint will perform a partial update on the dashboard's widget of the provided ID, updating the fields with the widget object provided in the body.
Parameters
Parameter
Description
Parameter Type
Data Type
authorization
The user's API token, preceded by the keyword Bearer (with a space between it and the token). For more information, please refer to the API tutorial