The base URL for the v1.0 API is: /api/v1
For example, a request to it's users endpoint will be http://localhost/api/v1/users

REST API v1.0 operations are available for the following categories:

Account

/account/activate/{token}

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

ParameterDescriptionParameter TypeData Type
token

The user's activation token.

pathstring

Response Class

{
  "userName": "string"
}

 

Error Status Codes

HTTP Status CodeReason
200Token validated
404Provided token is invalid
/account/reset_password/{token}

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

ParameterDescriptionParameter TypeData Type
token

The temporary password reset token

pathstring

Response Class

{
  "userName": "string"
}

 

Error Status Codes

HTTP Status CodeReason
200Reset token is valid
404Reset token is invalid
/account/begin_activate

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

ParameterDescriptionParameter TypeData Type
emailObj

The email address of the user to be activated.

body
{
  "email": "string"
}

Error Status Codes

HTTP Status CodeReason
204Email sent successfully
404Invalid email
/account/activate/{token}

The activate endpoint receives the activation token and a new password and updates the user's password accordingly.

Parameters

ParameterDescriptionParameter TypeData Type
token

The user's activation token.

pathstring
passwordObject

The new password (MD5).

body
{
  "password": "string"
}

Error Status Codes

HTTP Status CodeReason
204User activated successfully
404Invalid activation token
/account/begin_activate_bulk

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

ParameterDescriptionParameter TypeData Type
emailList

The list of user emails to be activated.

body
[
	{
  		"email": "string"
	}
]

Error Status Codes

HTTP Status CodeReason
204Email sent successfully
404Invalid email
/account/begin_reset_password

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

ParameterDescriptionParameter TypeData Type
emailObject

The email address of the user whose password needs to be reset.

body
{
  "email": "string"
}

Error Status Codes

HTTP Status CodeReason
204Email sent successfully
404Invalid email
/account/reset_password/{token}

The reset password endpoint receives the reset password token and a new password and updates the user's password accordingly.

Parameters

ParameterDescriptionParameter TypeData Type
token

The temporary password reset token.

pathstring
passwordObject

The new password (MD5).

body
{
  "password": "string"
}

Error Status Codes

HTTP Status CodeReason
204Password was reset successfully
404Reset token is invalid

Admin

/dashboards/admin

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. 

Response Class

[
  {
    "title": "string",
    "desc": "string",
    "oid": "string",
    "type": "string",
    "shares": [
      {
        "shareId": "string",
        "type": "user",
        "rule": "view",
        "subscribe": true
      }
    ],
    "style": {
      "name": "string",
      "palette": {
        "colors": [
          "string"
        ],
        "name": "string",
        "isSystem": true
      }
    },
    "owner": "string",
    "userId": "string",
    "created": "2016-02-29T10:18:57.986Z",
    "lastUpdated": "2016-02-29T10:18:57.986Z",
    "datasource": {
      "title": "string",
      "id": "string",
      "address": "string",
      "database": "string",
      "fullname": "string"
    },
    "filters": [
      {
        "jaql": {
          "dim": "string",
          "datatype": "string",
          "title": "string"
        }
      }
    ],
    "instanceType": "string",
    "layout": {
      "type": "string",
      "columns": [
        {
          "width": 0,
          "cells": [
            {
              "subcells": [
                {
                  "elements": [
                    {
                      "widgetId": "string",
                      "minHeight": 0,
                      "maxHeight": 0,
                      "minWidth": 0,
                      "maxWidth": 0,
                      "height": 0,
                      "defaultWidth": 0
                    }
                  ]
                }
              ]
            }
          ]
        }
      ]
    },
    "defaultFilters": [
      {
        "jaql": {
          "dim": "string",
          "datatype": "string",
          "title": "string"
        }
      }
    ]
  }
]

 

Parameters

ParameterDescriptionParameter TypeData Type
authorization

The user's API token, preceded by the keyword Bearer (with a space between it and the token). For more information, refer to the API tutorial.

headerstring
dashboardType

Dashboard instance type to filter by.

querystring
idDashboard ID to filter by.querystring
parentFolder

Parent folder ID to filter by.

querystring
name

Name to filter by.

querystring
datasourceTitle

Data source name to filter by.

querystring

Data source address to filter by.

querystring
fields

Whitelist of fields to return for each document. Can also define which fields to exclude by prefixing field names with -

querystring
sort

Field by which the results should be sorted. Ascending by default, descending if prefixed by -

querystring
skip

Number of results to skip from the start of the data set. To be used with the limit parameter for paging.

queryinteger
limit

How many results should be returned. To be used with theskip parameter for paging.

queryinteger
expand

List of fields that should be expanded (substitures their IDs with actual objects). May be nested using theresource.subResourceformat.

querystring
/dashboards/{id}/admin/change_owner

The change owner endpoint updates the owner of a dashboard according to the dashboard ID.

Response Class

 {
  "title": "string",
  "desc": "string",
  "oid": "string",
  "type": "string",
  "shares": [
    {
      "shareId": "string",
      "type": "user",
      "rule": "view",
      "subscribe": true
    }
  ],
  "style": {
    "name": "string",
    "palette": {
      "colors": [
        "string"
      ],
      "name": "string",
      "isSystem": true
    }
  },
  "owner": "string",
  "userId": "string",
  "created": "2016-02-29T10:18:57.999Z",
  "lastUpdated": "2016-02-29T10:18:57.999Z",
  "datasource": {
    "title": "string",
    "id": "string",
    "address": "string",
    "database": "string",
    "fullname": "string"
  },
  "filters": [
    {
      "jaql": {
        "dim": "string",
        "datatype": "string",
        "title": "string"
      }
    }
  ],
  "instanceType": "string",
  "layout": {
    "type": "string",
    "columns": [
      {
        "width": 0,
        "cells": [
          {
            "subcells": [
              {
                "elements": [
                  {
                    "widgetId": "string",
                    "minHeight": 0,
                    "maxHeight": 0,
                    "minWidth": 0,
                    "maxWidth": 0,
                    "height": 0,
                    "defaultWidth": 0
                  }
                ]
              }
            ]
          }
        ]
      }
    ]
  },
  "defaultFilters": [
    {
      "jaql": {
        "dim": "string",
        "datatype": "string",
        "title": "string"
      }
    }
  ]
}

 

Parameters

ParameterDescriptionParameter TypeData 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.

headerstring
id

The ID of the dashboard to update.

pathstring
ownerData

Object with the ID of new owner of a dashboard.

body
{
 "ownerId": "string",
 "originalOwnerRule": "edit"
}
/dashboards/{server}/{title}/replaceDatasource

The replace datasource endpoint replaces the datasource object of all the dashboards and widgets in the system.

Parameters

ParameterDescriptionParameter TypeData 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.

headerstring
server

Datasource server("Set" for elasticbe sets) to update.

pathstring
title

Datasource title to update.

path

string

dashboardId

The ID of the dashboard to get.

querystring 
datasource

The new datasource object.

body
{
  "title": "string",
  "id": "string",
  "address": "string",
  "database": "string",
  "fullname": "string"
}

Alerts

/alerts

The get alert endpoint provides access to a specified user's alert in their stored format as JSON objects.

Parameters

ParameterDescriptionParameter TypeData 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.

headerstring
ids

Array of alert IDs to get separated by a comma (,) and without spaces.

queryArray[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 -.

querystring 
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

limitHow many results should be returned. limit is to be used with the skip parameter for paging.querynumber
expandList of fields that should be expanded (substitures their IDs with actual objects). May be nested using the resource.subResource format.querystring
/alerts/{id}

The get alert by ID endpoint returns a specific alert object by ID.

Parameters

ParameterDescriptionParameter TypeData 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.

headerstring
id

The ID of the alert to get.

pathstring

/alerts/count

The alerts count endpoint returns the amount of alerts for a user if the user is the owner of the alerts.

Parameters

ParameterDescriptionParameter TypeData 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.

headerstring
/alerts

The add alert endpoint receives an alert object and adds it to the system's alerts.

Parameters

ParameterDescriptionParameter TypeData 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.

headerstring
alertBasic alert object to be added.bodyobject
/alerts/{id}

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

ParameterDescriptionParameter TypeData 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.

headerstring
idThe ID of the alert to be updated.pathstring
alertThe partial alert object whose field will be updated.bodyobject
/alerts/{id}/setReceiveNotification

The update receive notification endpoint removes or adds a specific user to be notified when the alert is being executed.

Parameters

ParameterDescriptionParameter TypeData 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.

headerstring
idThe ID of the alert to be updated.pathstring
alertThe user and parameter Whether to disable or enable the user.bodyobject
/alerts/{id}

The delete alert endpoint deletes an alert and all of it's related events.

Parameters

ParameterDescriptionParameter TypeData 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.

headerstring
id

The ID of the alert to be deleted.

pathstring

Analytics

/analytics/token

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

ParameterDescriptionParameter TypeData 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.

headerstring
/analytics/token/revoke

Revoke the token used to authenticate your calls to /analytics endpoints.

Parameters

ParameterDescriptionParameter TypeData 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.

headerstring
/analytics/collection/{collection}

Returns a collection of Sisense entities as defined in the collection parameter. Entities include objects such as ElastiCubes, widgets,users, groups, or dashboards.

Parameters

ParameterDescriptionParameter TypeData 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.

headerstring
collectionCollection name to be returned.pathstring

Application

/application/status

The application status endpoint provides information on the current status of the Sisense application.
It provides the version number and some licensing information.

 

Response Class

{
  "version": "string",
  "license": {
    "isMobileEnabled": true,
    "isExpired": true
  }
}

 

Error Status Codes

HTTP Status CodeReason
200Current application status

Authentication

/authentication/logout

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

ParameterDescriptionParameter TypeData Type
x-device-idThe device ID.headerstring
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.

headerstring
collectionCollection name to be returned.querystring

Error Status Codes

HTTP Status CodeReason
204Log out was performed successfully. The API token has been revoked.
401Unauthorized: Invalid API token.
/authentication/logout_all

The logout all endpoint revokes all if a user's existing tokens, both for the API and all devices.

Parameters

ParameterDescriptionParameter TypeData Type
x-device-idThe device ID.headerstring
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.

headerstring

Error Status Codes

HTTP Status CodeReason
204Log out was performed successfully. The API token has been revoked.
401Unauthorized: Invalid API token.
/authentication/admin/logout

The admin logout endpoint allows admin users to revoke all tokens of multiple users.

Parameters

ParameterDescriptionParameter TypeData Type
x-device-idThe device ID.headerstring
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.

headerstring
users

User IDs whose tokens are to be revoked, separated by a comma (,) and without spaces

queryArray[string]

Error Status Codes

HTTP Status CodeReason
204Tokens revoked successfully
401Invalid token
/authentication/server_access

The get all servers access endpoint returns a list of trusted servers that can copy dashboards to your server.

Parameters

ParameterDescriptionParameter TypeData 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.

headerstring

Error Status Codes

HTTP Status CodeReason
200An array of trusted servers
/authentication/login

The login endpoint validates passed credentials and returns an API token for subsequent requests to the API.

Response Class

{
  "success": true,
  "message": "string",
  "access_token": "string",
  "profile": {}
}

 

Error Status Codes

HTTP Status CodeReason
401Unauthorized: Invalid credentials. Wrong username or password.
/authentication/server_access

The add server access endpoint adds a trusted server with access to Sisense.

Parameters

ParameterDescriptionParameter TypeData 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.

headerstring
serverAccessThe server object (in JSON notation) to be added to the Trusted Server list.body 

Error Status Codes

HTTP Status CodeReason
200Server was added
400Server already exists
/authentication/login_saml_callback

The login_saml_callback endpoint receives passed SAML credentials and returns an API token for subsequent requests to the API.

Parameters

ParameterDescriptionParameter TypeData Type
RelayStateThe original URL that the user requested.

 

formDatastring
SAMLResponseResponse from SAML identity provider with decoded user data.formDatastring

Error Status Codes

HTTP Status CodeReason
302Redirect to the original URL
/authentication/server_access/{id}

The patch servers access endpoint edits a trusted server by its ID. You can revtrive the ID throught the get servers access endpoint.

Parameters

ParameterDescriptionParameter TypeData Type
authorizationThe 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.headerstring
idThe ID of the trusted server.pathstring
serverAccessThe server object (in JSON notation) to be edited in the Trusted Server list.body 

Error Status Codes

HTTP Status CodeReason
200No response was specified
/authentication/server_access/{id}

The delete servers access endpoint removes a trusted server from the Trusted Server Access list.

Parameters

ParameterDescriptionParameter TypeData Type
authorizationThe 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.headerstring
idThe ID of the trusted server.pathstring

Error Status Codes

HTTP Status CodeReason
200No response was specified
/authentication/admin/tokens/{tokenType}

The admin delete tokens endpoint allows admin users to revoke all API tokens of multiple users, leaving the device tokens intact.

Parameters

ParameterDescriptionParameter TypeData Type
authorizationThe 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.headerstring
tokenTypeThe ID of the trusted server.pathstring
usersUser IDs whose tokens are to be revoked, separated by a comma (,) and without spaces.queryArray[string]

Error Status Codes

HTTP Status CodeReason
204API token revoked successfully
401Invalid token

Connections

/connection

The get connection endpoint returns a list of configured connections.

Parameters

ParameterDescriptionParameter TypeData Type
sortDetermines how the results should be sorted. Ascending by default, descending if prefixed by -querystring
skipNumber of results to skip from the start of the data set. skip is to be used with the limit parameter for pagingqueryinteger
limitHow many results should be returned. limit is to be used with the skip parameter for pagingqueryintege
/connection/{id}

The get connection by ID endpoint returns a connection object by ID.

Parameters

ParameterDescriptionParameter TypeData Type
authorizationThe 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.headerstring
idThe ID of the live connection. You can retrieve this ID through the get /connection endpoint.pathinteger
/connection/recent

The list connections endpoint returns list of recently used connections.

/connection

The create connection endpoint creates a new connection object.

Parameters

ParameterDescriptionParameter TypeData Type
authorizationThe 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.headerstring
connectionThe new connection object.body 
/connection/{id}

The update connection endpoint updates a connection with new data.

Parameters

ParameterDescriptionParameter TypeData Type
authorizationThe 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.headerstring
idThe ID of the live connection. You can retrieve this ID through the get /connection endpoint.pathstring
connectionThe new connection object.body 
/connection/{id}

The delete connection endpoint removes a connection by ID.

Parameters

ParameterDescriptionParameter TypeData Type
authorizationThe 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.headerstring
idThe ID of the live connection. You can retrieve this ID through the get /connection endpoint.pathstring

Custom

/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

ParameterDescriptionParameter TypeData Type
authorizationThe 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.headerstring
/custom_data

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

ParameterDescriptionParameter TypeData Type
authorizationThe 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.headerstring
customDataObjectCustom data object to be added.body 
/custom_data/query

The get documents endpoint returns all document that match the query.

Parameters

ParameterDescriptionParameter TypeData Type
authorizationThe 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.headerstring
queryThe query to the MongoDB Collection.body 
/custom_data/query

The update documents endpoint updates (not rewrites) all documents that match query.

Parameters

ParameterDescriptionParameter TypeData Type
authorizationThe 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.headerstring
queryAndDataqueryForSearch is a query object to find records that need to be updated. objectForUpdate is the replacement object.body 
/custom_data/query

The get documents endpoint returns all document that match the query.

Parameters

ParameterDescriptionParameter TypeData Type
authorizationThe 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.headerstring
queryQuery to find and delete documents.body 

Dashboards

/dashboards

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

ParameterDescriptionParameter TypeData 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

headerstring
parentFolder

Parent folder ID to filter by

querystring
name

Name to filter by

querystring
datasourceTitle

Data source name to filter by

querystring
datasourceAddress

Data source address to filter by

querystring
fields

Whitelist of fields to return for each document. Can also define which fields to exclude by prefixing field names with -

querystring
sort

Field by which the results should be sorted. Ascending by default, descending if prefixed by -

querystring
skip

Number of results to skip from the start of the data set. To be used with the limit parameter for paging

queryinteger
limit

How many results should be returned. To be used with the skip parameter for paging

queryinteger
expand

List of fields that should be expanded (substitutes their IDs with actual objects). May be nested using the resource.subResource format

querystring

Response Class

[
  {
    "title": "string",
    "desc": "string",
    "oid": "string",
    "type": "string",
    "shares": [
      {
        "shareId": "string",
        "type": "user",
        "rule": "view",
        "subscribe": true
      }
    ],
    "style": {
      "name": "string",
      "palette": {
        "colors": [
          "string"
        ],
        "name": "string",
        "isSystem": true
      }
    },
    "owner": "string",
    "userId": "string",
    "created": "2015-11-15T13:39:24.483Z",
    "lastUpdated": "2015-11-15T13:39:24.483Z",
    "datasource": {
      "title": "string",
      "id": "string",
      "address": "string",
      "database": "string"
    },
    "filters": [
      {
        "jaql": {
          "dim": "string",
          "datatype": "string",
          "title": "string"
        }
      }
    ],
    "instanceType": "string",
    "layout": {
      "type": "string",
      "columns": [
        {
          "width": 0,
          "cells": [
            {
              "subcells": [
                {
                  "elements": [
                    {
                      "widgetId": "string",
                      "minHeight": 0,
                      "maxHeight": 0,
                      "minWidth": 0,
                      "maxWidth": 0,
                      "height": 0,
                      "defaultWidth": 0
                    }
                  ]
                }
              ]
            }
          ]
        }
      ]
    },
    "defaultFilters": [
      {
        "jaql": {
          "dim": "string",
          "datatype": "string",
          "title": "string"
        }
      }
    ]
  }
]

 

Error Status Codes

HTTP Status CodeReason
200An array of dashboards
/dashboards/{id}

The get dashboard by ID endpoint returns a specific dashboard object by ID.

The only expandable field for the dashboard object is widgets.

Parameters

ParameterDescriptionParameter TypeData 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

headerstring
id

The ID of the dashboard to get

pathstring
fields

Whitelist of fields to return for each document. Can also define which fields to exclude by prefixing field names with -

querystring
expand

List of fields that should be expanded (substitutes their IDs with actual objects). May be nested using the resource.subResource format

querystring

Response Class

{
  "title": "string",
  "desc": "string",
  "oid": "string",
  "type": "string",
  "shares": [
    {
      "shareId": "string",
      "type": "user",
      "rule": "view",
      "subscribe": true
    }
  ],
  "style": {
    "name": "string",
    "palette": {
      "colors": [
        "string"
      ],
      "name": "string",
      "isSystem": true
    }
  },
  "owner": "string",
  "userId": "string",
  "created": "2015-11-15T13:39:24.493Z",
  "lastUpdated": "2015-11-15T13:39:24.493Z",
  "datasource": {
    "title": "string",
    "id": "string",
    "address": "string",
    "database": "string"
  },
  "filters": [
    {
      "jaql": {
        "dim": "string",
        "datatype": "string",
        "title": "string"
      }
    }
  ],
  "instanceType": "string",
  "layout": {
    "type": "string",
    "columns": [
      {
        "width": 0,
        "cells": [
          {
            "subcells": [
              {
                "elements": [
                  {
                    "widgetId": "string",
                    "minHeight": 0,
                    "maxHeight": 0,
                    "minWidth": 0,
                    "maxWidth": 0,
                    "height": 0,
                    "defaultWidth": 0
                  }
                ]
              }
            ]
          }
        ]
      }
    ]
  },
  "defaultFilters": [
    {
      "jaql": {
        "dim": "string",
        "datatype": "string",
        "title": "string"
      }
    }
  ]
}

 

Error Status Codes

HTTP Status CodeReason
200The dashboard with the given ID
/dashboards/export

The export dashboards endpoint returns the dashboards JSON content in a .dash file, which can be imported into Sisense.

Parameters

ParameterDescriptionParameter TypeData 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

headerstring
dashboardId

The IDs of the dashboards to be exported.

queryArray[string]

Error Status Codes

HTTP Status CodeReason
404Dashboard not found
/dashboards/{id}/export/png

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

ParameterDescriptionParameter TypeData 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

headerstring
id

The ID of the dashboard to export

pathstring
includeTitle

Should dashboard title be included in the exported file

queryboolean
includeFilters

Should dashboard filters be included in the exported file

queryboolean
includeDs

Should dashboard data source info be included in the exported file

queryboolean
width

Render width in pixels

querystring

Error Status Codes

HTTP Status CodeReason
200Image file
/dashboards/{id}/export/pdf

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

ParameterDescriptionParameter TypeData 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

headerstring
id

The ID of the dashboard to export

pathstring
includeTitle

Should dashboard title be included in the exported file

queryboolean
includeFilters

Should dashboard filters be included in the exported file

queryboolean
includeDs

Should dashboard data source info be included in the exported file

queryboolean
paperFormat

What paper format should be used while rendering the dashboard

querystring
paperOrientation

What paper orientation should be used while rendering the dashboard

querystring
layout

What layout should be used while rendering the dashboard, as is or feed

querystring

Error Status Codes

HTTP Status CodeReason
200PDF file
/dashboards/{id}/export/dash

The export dashboard to .dash file endpoint returns the dashboard's JSON in a .dash file that can be later imported into Sisense.

Parameters

ParameterDescriptionParameter TypeData 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

headerstring
id

The ID of the dashboard to export

pathstring

Error Status Codes

HTTP Status CodeReason
200Dash file
/dashboards/{dashboardId}/shares

The get shares endpoint returns a dashboard's share configurations.

The expandable fields for the shares object are group and user.

Parameters

ParameterDescriptionParameter TypeData 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

headerstring
dashboardId

The ID of the dashboard who's shares to get.

pathstring
fields

Whitelist of fields to return for each document. Can also define which fields to exclude by prefixing field names with -

querystring
expand

List of fields that should be expanded (substitutes their IDs with actual objects). May be nested using the resource.subResource format

querystring

Response Class

[
  {
    "shareId": "string",
    "type": "user",
    "rule": "view",
    "subscribe": true
  }
]

 

Error Status Codes

HTTP Status CodeReason
200An array of the dashboard's sharing configurations
404expand resource not found
/dashboards/{dashboardId}/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

ParameterDescriptionParameter TypeData 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

headerstring
dashboardId

The ID of the dashboard to get

pathstring
title

Widget title to filter by

querystring
type

Widget type to filter by

querystring
subtype

Widget sub-type to filter by

querystring
fields

Whitelist of fields to return for each document. Can also define which fields to exclude by prefixing field names with -

querystring
sort

Field by which the results should be sorted. Ascending by default, descending if prefixed by -

querystring
skip

Number of results to skip from the start of the data set. To be used with the limit parameter for paging

queryinteger
limit

How many results should be returned. To be used with the skip parameter for paging

queryinteger

Response Class

[
  {
    "title": "string",
    "oid": "string",
    "datasource": {
      "title": "string",
      "id": "string",
      "address": "string",
      "database": "string"
    },
    "type": "string",
    "subtype": "string",
    "dashboardid": "string",
    "owner": "string",
    "userId": "string",
    "instanceType": "string",
    "lastUpdated": "2015-11-15T13:39:24.518Z",
    "metadata": {
      "panels": [
        {
          "name": "string",
          "items": [
            {
              "jaql": {
                "dim": "string",
                "datatype": "string",
                "title": "string"
              },
              "field": {
                "id": "string",
                "index": 0
              },
              "format": {}
            }
          ]
        }
      ]
    },
    "shares": [
      {
        "shareId": "string",
        "type": "user",
        "rule": "view",
        "subscribe": true
      }
    ]
  }
]

 

Error Status Codes

HTTP Status CodeReason
200An array of widgets
/dashboards/{dashboardId}/shares/{id}

The get share by id endpoint returns the details of a specific share of the dashboard.

The expandable fields for the shares object are group and user.

Parameters

ParameterDescriptionParameter TypeData 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

headerstring
dashboardId

The ID of the dashboard to get.

pathstring
id

The ID of the share to get.

pathstring
fields

Whitelist of fields to return for each document. Can also define which fields to exclude by prefixing field names with -

querystring
expand

List of fields that should be expanded (substitures their IDs with actual objects). May be nested using the resource.subResource format

querystring

Response Class

{
  "shareId": "string",
  "type": "user",
  "rule": "view",
  "subscribe": true
}

 

Error Status Codes

HTTP Status CodeReason
200A dashboard share configuration
404expand resource not found
/dashboards/{dashboardId}/widgets/{id}

The get dashboard widget by ID endpoint returns a specific widget (by ID) from a specific dashboard.

Parameters

ParameterDescriptionParameter TypeData 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

headerstring
dashboardId

The ID of the dashboard containing the widget

pathstring
id

The ID of the widget to get

pathstring
fields

Whitelist of fields to return for each document. Can also define which fields to exclude by prefixing field names with -

querystring

Response Class

{
  "title": "string",
  "oid": "string",
  "datasource": {
    "title": "string",
    "id": "string",
    "address": "string",
    "database": "string"
  },
  "type": "string",
  "subtype": "string",
  "dashboardid": "string",
  "owner": "string",
  "userId": "string",
  "instanceType": "string",
  "lastUpdated": "2015-11-15T13:39:24.532Z",
  "metadata": {
    "panels": [
      {
        "name": "string",
        "items": [
          {
            "jaql": {
              "dim": "string",
              "datatype": "string",
              "title": "string"
            },
            "field": {
              "id": "string",
              "index": 0
            },
            "format": {}
          }
        ]
      }
    ]
  },
  "shares": [
    {
      "shareId": "string",
      "type": "user",
      "rule": "view",
      "subscribe": true
    }
  ]
}

 

Error Status Codes

HTTP Status CodeReason
200The widget with the given ID
/dashboards/{dashboardId}/widgets/{id}/export/png

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

ParameterDescriptionParameter TypeData 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

headerstring
dashboardId

The ID of the dashboard containing the widget

pathstring
id

The ID of the widget to export

pathstring
width

Render width in pixels

querystring
height

Render height in pixels

querystring

 

Error Status Codes

HTTP Status CodeReason
200Image file
/dashboards

The add dashboard endpoint receives a dashboard object and adds it to the user's dashboards.

Parameters

ParameterDescriptionParameter TypeData 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

headerstring
dashboard

Basic dashboard object to be added

body
{
  "title": "string",
  "desc": "string",
  "datasource": {
    "title": "string",
    "id": "string",
    "address": "string",
    "database": "string"
  },
  "filters": [
    {
      "jaql": {
        "dim": "string",
        "datatype": "string",
        "title": "string"
      }
    }
  ],
  "layout": {
    "type": "string",
    "columns": [
      {
        "width": 0,
        "cells": [
          {
            "subcells": [
              {
                "elements": [
                  {
                    "widgetId": "string",
                    "minHeight": 0,
                    "maxHeight": 0,
                    "minWidth": 0,
                    "maxWidth": 0,
                    "height": 0,
                    "defaultWidth": 0
                  }
                ]
              }
            ]
          }
        ]
      }
    ]
  },
  "defaultFilters": [
    {
      "jaql": {
        "dim": "string",
        "datatype": "string",
        "title": "string"
      }
    }
  ]
}

Error Status Codes

HTTP Status CodeReason
201No response was specified
/dashboards/copy

The copy dashboards to server endpoint copies the seleteced dashboards to a remote Sisense server.

Parameters

ParameterDescriptionParameter TypeData 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

headerstring
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).

queryboolean
forceContinue even when the dashboard is not compatible with the target server's version of Sisense.queryboolean

Error Status Codes

HTTP Status CodeReason
200The dashboards were copied
/dashboards/import

The import dashboard endpoint receives the metadata of a dashboard and import the dashboard on to another Sisense instance.

Parameters

ParameterDescriptionParameter TypeData 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

headerstring
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.

 

body
{
  "title": "string",
  "desc": "string",
  "datasource": {
    "title": "string",
    "id": "string",
    "address": "string",
    "database": "string"
  },
  "filters": [
    {
      "jaql": {
        "dim": "string",
        "datatype": "string",
        "title": "string"
      }
    }
  ],
  "layout": {
    "type": "string",
    "columns": [
      {
        "width": 0,
        "cells": [
          {
            "subcells": [
              {
                "elements": [
                  {
                    "widgetId": "string",
                    "minHeight": 0,
                    "maxHeight": 0,
                    "minWidth": 0,
                    "maxWidth": 0,
                    "height": 0,
                    "defaultWidth": 0
                  }
                ]
              }
            ]
          }
        ]
      }
    ]
  },
  "defaultFilters": [
    {
      "jaql": {
        "dim": "string",
        "datatype": "string",
        "title": "string"
      }
    }
  ]
}
importFolder

The folder to add the imported dashboard to

querystring

Error Status Codes

HTTP Status CodeReason
201No response was specified
/dashboards/import/bulk/

The import dashboard endpoint receives a .dash file containing dashboards and adds those dashboards to the user's Dashboard list.

Parameters

ParameterDescriptionParameter TypeData 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

headerstring
dashboards

Basic dashboard object to be added.

body

 

 

actionDetermines 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.querystring
republishRepublish dashboards on target server after copying (only affects overwritten dashboards that were previously shared on the target server).queryboolean
importFolderThe folder to add the imported dashboard to.querystring
/dashboards/{id}/restore

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

ParameterDescriptionParameter TypeData 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

headerstring
id

The ID of the dashboard to be restored.

pathstring

Error Status Codes

HTTP Status CodeReason
204

Operation was successfull

404

Dashboard not found

/dashboards/{id}/publish

The publish dashboard endpoint sets the dashboard as the published version of it for the shared users to see.

Parameters

ParameterDescriptionParameter TypeData 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

headerstring
id

The ID of the dashboard to publish

pathstring

Error Status Codes

HTTP Status CodeReason
204

Operation was successfull

404

Dashboard not found


/dashboards/{id}/undo_Import

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

ParameterDescriptionParameter TypeData 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

headerstring
id

The ID of the dashboard to be restored

pathstring

Error Status Codes

HTTP Status CodeReason
204

Operation was successfull

404

Dashboard not found

 

/dashboards/{id}/duplicate

The duplicate dashboard endpoint creates a new dashboard based on an existing dashboard of the provided ID.

Parameters

ParameterDescriptionParameter TypeData 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

headerstring
id

The ID of the dashboard to duplicate

pathstring

Error Status Codes

HTTP Status CodeReason
201No response was specified
/dashboards/{id}/change_owner

The change owner endpoint update owner of existing and specified by ID dashboard if called by current dashboards owner.

Response

 

{
  "title": "string",
  "desc": "string",
  "oid": "string",
  "type": "string",
  "shares": [
    {
      "shareId": "string",
      "type": "user",
      "rule": "view",
      "subscribe": true
    }
  ],
  "style": {
    "name": "string",
    "palette": {
      "colors": [
        "string"
      ],
      "name": "string",
      "isSystem": true
    }
  },
  "owner": "string",
  "userId": "string",
  "created": "2016-02-29T10:18:58.141Z",
  "lastUpdated": "2016-02-29T10:18:58.141Z",
  "datasource": {
    "title": "string",
    "id": "string",
    "address": "string",
    "database": "string",
    "fullname": "string"
  },
  "filters": [
    {
      "jaql": {
        "dim": "string",
        "datatype": "string",
        "title": "string"
      }
    }
  ],
  "instanceType": "string",
  "layout": {
    "type": "string",
    "columns": [
      {
        "width": 0,
        "cells": [
          {
            "subcells": [
              {
                "elements": [
                  {
                    "widgetId": "string",
                    "minHeight": 0,
                    "maxHeight": 0,
                    "minWidth": 0,
                    "maxWidth": 0,
                    "height": 0,
                    "defaultWidth": 0
                  }
                ]
              }
            ]
          }
        ]
      }
    ]
  },
  "defaultFilters": [
    {
      "jaql": {
        "dim": "string",
        "datatype": "string",
        "title": "string"
      }
    }
  ]
}

 

Parameters

ParameterDescriptionParameter TypeData 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

headerstring
id

The ID of the dashboard to update

pathstring
ownerdata

Object with the ID of new owner of a dashboard

body
{
  "ownerId": "string",
  "originalOwnerRule": "edit"
}
/dashboards/{dashboardId}/widgets

The add widget to dashboard endpoint adds the provided widget object to the dashboard of the given ID.

Parameters

ParameterDescriptionParameter TypeData 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

headerstring
dashboardId

The ID of the dashboard to add the widget to

pathstring
widget

Basic widget object to be added to the dashboard

body
{
  "title": "string",
  "datasource": {
    "title": "string",
    "id": "string",
    "address": "string",
    "database": "string"
  },
  "type": "string",
  "subtype": "string",
  "metadata": {
    "panels": [
      {
        "name": "string",
        "items": [
          {
            "jaql": {
              "dim": "string",
              "datatype": "string",
              "title": "string"
            },
            "field": {
              "id": "string",
              "index": 0
            },
            "format": {}
          }
        ]
      }
    ]
  }
}

Error Status Codes

HTTP Status CodeReason
201No response was specified
/dashboards/{id}

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

ParameterDescriptionParameter TypeData 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

headerstring
id

The ID of the dashboard to update

pathstring
dashboard

The partial dashboard object who's fields will be updated

body
{
  "title": "string",
  "desc": "string",
  "oid": "string",
  "type": "string",
  "shares": [
    {
      "shareId": "string",
      "type": "user",
      "rule": "view",
      "subscribe": true
    }
  ],
  "style": {
    "name": "string",
    "palette": {
      "colors": [
        "string"
      ],
      "name": "string",
      "isSystem": true
    }
  },
  "owner": "string",
  "userId": "string",
  "created": "2015-11-15T13:39:24.445Z",
  "lastUpdated": "2015-11-15T13:39:24.445Z",
  "datasource": {
    "title": "string",
    "id": "string",
    "address": "string",
    "database": "string"
  },
  "filters": [
    {
      "jaql": {
        "dim": "string",
        "datatype": "string",
        "title": "string"
      }
    }
  ],
  "instanceType": "string",
  "layout": {
    "type": "string",
    "columns": [
      {
        "width": 0,
        "cells": [
          {
            "subcells": [
              {
                "elements": [
                  {
                    "widgetId": "string",
                    "minHeight": 0,
                    "maxHeight": 0,
                    "minWidth": 0,
                    "maxWidth": 0,
                    "height": 0,
                    "defaultWidth": 0
                  }
                ]
              }
            ]
          }
        ]
      }
    ]
  },
  "defaultFilters": [
    {
      "jaql": {
        "dim": "string",
        "datatype": "string",
        "title": "string"
      }
    }
  ]
}

Error Status Codes

HTTP Status CodeReason
200 
/dashboards/{dashboardId}/widgets/{id}

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

ParameterDescriptionParameter TypeData 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

headerstring
dashboardId

The ID of the dashboard to add the widget to

pathstring
idThe ID of the widget to updatepathstring
widget

Basic widget object to be added to the dashboard

body
{
  "title": "string",
  "oid": "string",
  "datasource": {
    "title": "string",
    "id": "string",
    "address": "string",
    "database": "string"
  },
  "type": "string",
  "subtype": "string",
  "dashboardid": "string",
  "owner": "string",
  "userId": "string",
  "instanceType": "string",
  "lastUpdated": "2015-11-15T13:39:24.448Z",
  "metadata": {
    "panels": [
      {
        "name": "string",
        "items": [
          {
            "jaql": {
              "dim": "string",
              "datatype": "string",
              "title": "string"
            },
            "field": {
              "id": "string",
              "index": 0
            },
            "format": {}
          }
        ]
      }
    ]
  },
  "shares": [
    {
      "shareId": "string",
      "type": "user",
      "rule": "view",
      "subscribe": true
    }
  ]
}

Error Status Codes

HTTP Status CodeReason
201No response was specified
/dashboards/{id}

The delete dashboard endpoint will delete the dashboard with the provided ID.

Parameters

ParameterDescriptionParameter TypeData 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

headerstring
id

The ID of the dashboard to delete

pathstring

Error Status Codes

HTTP Status CodeReason
200Delete operation was successful
/dashboards/bulk

The delete dashboard endpoint will delete the dashboard with the provided ID.

Parameters

ParameterDescriptionParameter TypeData 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

headerstring
id

The ID of the dashboard to delete

pathstring

Error Status Codes

HTTP Status CodeReason
200Delete operation was successful
/dashboards/{dashboardId}/widgets/{id}

The delete dashboards endpoint deletes dashboards with the provided IDs.

Parameters

ParameterDescriptionParameter TypeData 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

headerstring
dashboardIds

The IDs of the dashboards to be deleted.

queryArray[string]

Error Status Codes

HTTP Status CodeReason
200Delete operation was successful
404Dashboard not found

Datasets

/datasets

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

ParameterDescriptionParameter TypeData 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

headerstring
fields

Whitelist of fields to return for each document. fields can also define which fields to exclude by prefixing field names with -

queryArray[string]
/datasets/{id}

The get dataset endpoint returns a dataset object by ID.

Parameters

ParameterDescriptionParameter TypeData 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

headerstring
id

The ID of the live connection. You can retrieve this ID through the GET /datasets ID

queryArray[string]

Error Status Codes

HTTP Status CodeReason
404Dataset not found
/datasets/{id}/transformed

The get dataset endpoint returns a dataset object with an applied schema transformation by ID. 

Parameters

ParameterDescriptionParameter TypeData 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

headerstring
id

The ID of the live connection. You can retrieve this ID through the GET /datasets ID

queryArray[string]

Error Status Codes

HTTP Status CodeReason
404Dataset not found
/datasets/{id}/permissions

The get dataset permissions endpoint returns the permissions for a dataset.

Parameters

ParameterDescriptionParameter TypeData 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

headerstring
id

The ID of the live connection. You can retrieve this ID through the GET /datasets ID

queryArray[string]

Error Status Codes

HTTP Status CodeReason
404Dataset not found
/datasets/by_fullname/{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

ParameterDescriptionParameter TypeData Type
fullname

The datasets fullname

headerstring
expand

List of fields that should be expanded (substitutes their IDs with actual objects). May be nested using the resource.subResource format

queryArray[string]

Error Status Codes

HTTP Status CodeReason
404Dataset not found
/datasets/{fullname}/datasecurity

The get data security endpoint returns the data security rules set up for a data set.

Parameters

ParameterDescriptionParameter TypeData Type
authorizationThe 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 tutorialheaderstring
fullname

The datasets fullname

headerstring

Error Status Codes

HTTP Status CodeReason
404Dataset not found
/datasets/

The create dataset endpoint creates a new dataset object.

Parameters

ParameterDescriptionParameter TypeData Type
authorizationThe 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 tutorialheaderstring
dataset

The dataset object that defines a dataset

body 

Error Status Codes

HTTP Status CodeReason
400

Bad request error.

  • 23004 Name duplication error
  • 23003 Connection not found
/datasets/{fullname}/datasecurity

The create data context endpoint creates new data context object.

Parameters

ParameterDescriptionParameter TypeData Type
authorizationThe 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 tutorialheaderstring
fullnameThe dataset’s fullnamepathstring 
dataCOntextThe data context object that defines a dataset’s permissionsbody 

Error Status Codes

HTTP Status CodeReason
400

Bad request error.

  • 30001 Invalid default rule
  • 30003 Duplicate user or group
  • 30004 User or group not found
404Dataset not found
/datasets/{id}

The update dataset endpoint updates a dataset with new data.

Parameters

ParameterDescriptionParameter TypeData Type
authorizationThe 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 tutorialheaderstring
idThe dataset's ID. You can retrieve a dataset's ID through the GET /datasets endpointpathstring 
datasetThe dataset object that defines a dataset body 

Error Status Codes

HTTP Status CodeReason
200Updated dataset
400

Bad request error.

  • 23001 Permission error
  • 23003 Connection not found
  • 23004 Name duplication error
404Dataset not found
/datasets/{id}/permissions

The update dataset endpoint updates the dataset with the fetched permissions.

Parameters

ParameterDescriptionParameter TypeData Type
authorizationThe 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 tutorialheaderstring
idThe dataset's ID. You can retrieve a dataset's ID through the GET /datasets endpointpathstring 
permissionsThe dataset object that defines a dataset body 

Error Status Codes

HTTP Status CodeReason
400

Bad request error.

  • 23001 Permission error
  • 23005 User not found
  • 23006 Group not found
404Dataset not found
/datasets/{id}

The remove dataset endpoint removes a dataset by ID.

Parameters

ParameterDescriptionParameter TypeData Type
authorizationThe 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 tutorialheaderstring
idThe dataset's ID. You can retrieve a dataset's ID through the GET /datasets endpointpathstring 

Error Status Codes

HTTP Status CodeReason
204Dataset was successfully removed
400

Bad request error.

  • 23001 Permission error
404Dataset not found
/datasets/datasecurity/{dataSecurityId}

The remove data context endpoint removes the specified data context by its ID.

Parameters

ParameterDescriptionParameter TypeData Type
authorizationThe 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 tutorialheaderstring
dataSecurityIdThe ID of the data context object to be removedpathstring 

Error Status Codes

HTTP Status CodeReason
204Dataset was successfully removed
400

Bad request error.

  • 23001 Permission error
404Dataset not found
/datasets/{fullname}/datasecurity/{table}/{column}

The remove data context endpoint removes the specified data context column according to received parameters.

Parameters

ParameterDescriptionParameter TypeData Type
authorizationThe 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 tutorialheaderstring
fullnameThe dataset’s fullnamepathstring 
tableThe table name for the relevant data context objectpathstring 
columnThe column name for the relevant data context objectpathstring 

Error Status Codes

HTTP Status CodeReason
204Data Context column was removed successfully
404Dataset not found

ElastiCubes

/elasticubes/sets

The get ElastiCube sets endpoint returns a list of ElastiCube sets.

Parameters

ParameterDescriptionParameter TypeData Type
authorizationThe 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 tutorialheaderstring

Error Status Codes

HTTP Status CodeReason
404Resource not found
/elasticubes/sets/{title}

The get ElastiCube sets endpoint returns a list of ElastiCube sets.

Parameters

ParameterDescriptionParameter TypeData Type
authorizationThe 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 tutorialheaderstring
titleThe title of the ElastiCube Set to be returnedpathstring

Error Status Codes

HTTP Status CodeReason
404Resource not found
/elasticubes/{server}/{title}/revision

The get ElastiCube revision endpoint returns an ElastiCube and ElastiCube set's build revision.

Parameters

ParameterDescriptionParameter TypeData Type
authorizationThe 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 tutorialheaderstring
serverThe server of the ElastiCube to be returnedpathstring
titleThe title of the ElastiCube to be returnedpathstring

Error Status Codes

HTTP Status CodeReason
404Resource not found
/elasticubes/{server}/{title}/custom_tables

The get custom tables endpoint returns a list of SQL queries for custom tables and their table names.

Parameters

ParameterDescriptionParameter TypeData Type
authorizationThe 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 tutorialheaderstring
serverThe server of the ElastiCube to be returnedpathstring
titleThe title of the ElastiCube to be returnedpathstring

Error Status Codes

HTTP Status CodeReason
403Forbidden
500Internal server error
/elasticubes/{server}/{title}/{tableName}/relations

The get relations endpoint returns an ElastiCube table’s relations.

Parameters

ParameterDescriptionParameter TypeData Type
authorizationThe 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 tutorialheaderstring
serverThe server of the ElastiCube to getpathstring
titleThe title of the ElastiCube to getpathstring
tableNameThe title of the table to getpathstring

Error Status Codes

HTTP Status CodeReason
403Forbidden
500Internal server error
/elasticubes/{server}/{title}/{tableName}/custom_fields

The get custom fields endpoint returns a list of custom fields and their SQL queries.

Parameters

ParameterDescriptionParameter TypeData Type
authorizationThe 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 tutorialheaderstring
serverThe server of the ElastiCube to getpathstring
titleThe title of the ElastiCube to getpathstring
tableNameThe title of the table to getpathstring

Error Status Codes

HTTP Status CodeReason
403Forbidden
500Internal server error
/elasticubes/{server}/{title}/custom_tables/{tableName}

The get custom table endpoint returns an SQL query for a custom table in an ElastiCube.

Parameters

ParameterDescriptionParameter TypeData Type
authorizationThe 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 tutorialheaderstring
serverThe server of the ElastiCube to getpathstring
titleThe title of the ElastiCube to getpathstring
tableNameThe title of the table to getpathstring

Error Status Codes

HTTP Status CodeReason
403Forbidden
500Internal server error
/elasticubes/{server}/{title}/sql_manual_query/{tableName}

The get sql manual query endpoint returns an SQL query for an ElastiCube table.

Parameters

ParameterDescriptionParameter TypeData Type
authorizationThe 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 tutorialheaderstring
serverThe server of the ElastiCube to getpathstring
titleThe title of the ElastiCube to getpathstring
tableNameThe title of the table to getpathstring

Error Status Codes

HTTP Status CodeReason
403Forbidden
500Internal server error
/elasticubes/{server}/{title}/{tableName}/custom_fields/{fieldName}

The get custom field endpoint returns the SQL query of a custom field.

Parameters

ParameterDescriptionParameter TypeData Type
authorizationThe 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 tutorialheaderstring
serverThe server of the ElastiCube to getpathstring
titleThe title of the ElastiCube to getpathstring
tableNameThe title of the table to getpathstring
fieldNameThe title of the table field to getpathstring

Error Status Codes

HTTP Status CodeReason
403Forbidden
500Internal server error
/elasticubes/sets

The add ElastiCube Set endpoint 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

ParameterDescriptionParameter TypeData Type
authorizationThe 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 tutorialheaderstring
setBasic ElastiCube set object (in JSON notation) to be addedbody 

Error Status Codes

HTTP Status CodeReason
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
/elasticubes/{elasticube}/jaql/explain

The explain Jaql endpoint explains the jaql.

Parameters

ParameterDescriptionParameter TypeData Type
authorizationThe 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 tutorialheaderstring
rowcountWhether to include row countqueryboolean
uniquecountWhether to include unique countqueryboolean
jaqlJaql object to be explainedbody 

Error Status Codes

HTTP Status CodeReason
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
/elasticubes/{server}/{title}/custom_tables

The post custom tables endpoint creates a custom table on an ElastiCube through an SQL query.

Parameters

ParameterDescriptionParameter TypeData Type
authorizationThe 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 tutorialheaderstring
server

The server of the ElastiCube where the custom table is to be created

pathstring
title

The title of the ElastiCube where the custom table is to be created

pathstring
tableSqlQueryThe tableSqlQuery object that defines the SQL query that creates a table and the name of the custom tablebody 

Error Status Codes

HTTP Status CodeReason
403Forbidden
500Internal server error
/elasticubes/{server}/{title}/sql_manual_query

The post sql manual query endpoint creates an SQL query on an ElastiCube.

Parameters

ParameterDescriptionParameter TypeData Type
authorizationThe 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 tutorialheaderstring
server

The server of the ElastiCube where the custom table is to be created

pathstring
title

The title of the ElastiCube where the custom table is to be created

pathstring
manualTableSqlQuery

The manualTableSqlQuery object that defines the SQL query that creates a table and the name of the new table

body 

Error Status Codes

HTTP Status CodeReason
403Forbidden
500Internal server error
/elasticubes/{server}/{title}/{tableName}/relations

The post relations endpoint creates a new relationship between two fields in an ElastiCube table.

Parameters

ParameterDescriptionParameter TypeData Type
authorizationThe 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 tutorialheaderstring
server

The server of the ElastiCube where the custom table is to be created

pathstring
title

The title of the ElastiCube where the custom table is to be created

pathstring
tableName

The title of the table where the relation is to be created

path string
fieldUpdateRelation

The fieldUpdateRelation object that defines the relation between two fields in a table

body 

Error Status Codes

HTTP Status CodeReason
403Forbidden
500Internal server error

/elasticubes/{server}/{title}/{tableName}/custom_fields

The post custom fields endpoint adds a custom field to a table.

Parameters

ParameterDescriptionParameter TypeData Type
authorizationThe 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 tutorialheaderstring
server

The server of the ElastiCube where the custom table is to be created

pathstring
title

The title of the ElastiCube where the custom table is to be created

pathstring
tableName

The title of the table where the relation is to be created

path string
fieldSqlQuery

The fieldSqlQuery object that defines the SQL query and the name of the custom field

body 

Error Status Codes

HTTP Status CodeReason
403Forbidden
500Internal server error
/elasticubes/sets/{title}

The update ElastiCube set endpoint updates the ElastiCube set by title and returns the updated object.

Parameters

ParameterDescriptionParameter TypeData Type
authorizationThe 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 tutorialheaderstring
title

The title of the ElastiCube set to update

pathstring
set

Basic ElastiCube set object (in JSON notation) to be added

body 

Error Status Codes

HTTP Status CodeReason
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
  • 22006 The ElastiCube set not found
/elasticubes/{server}/{title}/{tableName}/relations

The patch relations endpoint updates a relation between two fields in an ElastiCube table.

Parameters

ParameterDescriptionParameter TypeData Type
authorizationThe 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 tutorialheaderstring
server

The server of the ElastiCube where the relation is to be updated

pathstring
title

The title of the ElastiCube where the relation is to be updated

pathstring
tableName

The title of the table where the relation is to be updated

path string
fieldUpdateRelation

The fieldUpdateRelation object that defines the relation between two fields in a table

body 

Error Status Codes

HTTP Status CodeReason
403Forbidden
500Internal server error
/elasticubes/{server}/{title}/custom_tables/{tableName}

The patch custom table endpoint updates a custom table’s SQL query.

Parameters

ParameterDescriptionParameter TypeData Type
authorizationThe 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 tutorialheaderstring
serverThe server of the ElastiCube where the custom table is to be updatedpathstring
titleThe title of the ElastiCube where the custom table is to be updatedpathstring
tableNameThe title of the table where the custom table is to be updatedpathstring
sqlQueryThe sqlQuery object that defines the SQL query of the custom tablebody 

Error Status Codes

HTTP Status CodeReason
403Forbidden
500Internal server error
/elasticubes/{server}/{title}/sql_manual_query/{tableName}

The update sql manual query endpoint updates the SQL query of an ElastiCube table.

Parameters

ParameterDescriptionParameter TypeData Type
authorizationThe 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 tutorialheaderstring
serverThe server of the ElastiCube where the SQL query is to be updatedpathstring
titleThe title of the ElastiCube where the SQL query is to be updatedpathstring
tableNameThe title of the table where the SQL query is to be updatedpathstring
manualTableSqlQuery

The new SQL query that replaces the existing query

body 

Error Status Codes

HTTP Status CodeReason
403Forbidden
500Internal server error
/elasticubes/{server}/{title}/{tableName}/custom_fields/{fieldName}

The patch custom field endpoint updates the SQL query of a custom field.

Parameters

ParameterDescriptionParameter TypeData Type
authorizationThe 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 tutorialheaderstring
serverThe server of the ElastiCube where the custom field is to be updatedpathstring
titleThe title of the ElastiCube where the custom field is to be updatedpathstring
tableName

The title of the table where the custom field is to be updated

pathstring
fieldName

The title of the table filed where the custom field is to be updated

  
sqlQuery

The sqlQuery object that defines the SQL query of a custom field

body 

Error Status Codes

HTTP Status CodeReason
403Forbidden
500Internal server error
/elasticubes/sets/{title}

The delete ElastiCube set endpoint deletes the ElastiCube set by title.

Parameters

ParameterDescriptionParameter TypeData Type
authorizationThe 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 tutorialheaderstring
title

 

The title of the ElastiCube set to delete

pathstring

Error Status Codes

HTTP Status CodeReason
400
  • 22006 The ElastiCube set not found
/elasticubes/{server}/{title}/{tableName}/relations

The delete relations endpoint deletes a relation between two fields in an ElastiCube table.

Parameters

ParameterDescriptionParameter TypeData Type
authorizationThe 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 tutorialheaderstring
serverThe server of the ElastiCube where the relation is to be deletedpathstring
titleThe title of the ElastiCube where the relation is to be deletedpathstring
tableNameThe title of the table where the relation is to be deletedpathstring
fieldRelation

The fieldUpdateRelation object that defines which realtion delete in a table

body 

Error Status Codes

HTTP Status CodeReason
403

Forbidden

500Internal Server Error
/elasticubes/{server}/{title}/custom_tables/{tableName}

The delete custom table endpoint deletes the SQL query that defines a custom table, removing the table.

Parameters

ParameterDescriptionParameter TypeData Type
authorizationThe 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 tutorialheaderstring
serverThe server of the ElastiCube where the custom table is to be deletedpathstring
titleThe title of the ElastiCube where the custom table is to be deletedpathstring
tableNameThe title of the table where the custom table is to be deletedpathstring

Error Status Codes

HTTP Status CodeReason
403

Forbidden

500Internal Server Error
/elasticubes/{server}/{title}/sql_manual_query/{tableName}

The delete sql manual query endpoint deletes the SQL query of an ElastiCube table.

Parameters

ParameterDescriptionParameter TypeData Type
authorizationThe 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 tutorialheaderstring
serverThe server of the ElastiCube where the SQL query is to be deletedpathstring
titleThe title of the ElastiCube to get where the SQL query is to be deletedpathstring
tableNameThe title of the table where the SQL query is to be deletedpathstring

Error Status Codes

HTTP Status CodeReason
403

Forbidden

500Internal Server Error
/elasticubes/{server}/{title}/{tableName}/custom_fields/{fieldName}

The delete custom field endpoint deletes the SQL query that creates a custom field removing the field from the table.

Parameters

ParameterDescriptionParameter TypeData Type
authorizationThe 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 tutorialheaderstring
serverThe server of the ElastiCube where the custom field is to be deletedpathstring
titleThe title of the ElastiCube where the custom field is to be deletedpathstring
tableNameThe title of the table where the custom field is to be deletedpathstring
fieldNameThe title of the table filed to get  

Error Status Codes

HTTP Status CodeReason
403

Forbidden

500Internal Server Error

Features

/features

The /features endpoint returns a list of features you can enable/disbale.

Parameters

ParameterDescriptionData 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
keyName of the feature. You can use the values returned in this array to enable/disable features.string
activeStatus of the feature, enabled or disabled.boolean
nameName of the feature.string
descriptionDescription of the feature.string
subscriptionsArray 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
nameName of the functionality within a feature that can be enabled or disabled, for example, buildSubscription or kpiSubscription.array
activeStatus of the feature, enabled or disabled.boolean
/features/{key}/toggle

The toggle endpoint turns a specific feature on or off.

Parameters

ParameterDescriptionParameter TypeData 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

headerstring
key

The ID of the dashboard to delete

pathstring
toggleFeatureIndicates if the feature should be enabled or disabled.pathboolean

Error Status Codes

HTTP Status CodeReason
404Feature not found

Folders

/folders

Get all folders

/folders/{id}Get a specific folder
/folders/{id}/subtreeGet a subtree of a specific folder
/folders/{id}/ancestorsGet the ancestors of a specific folder
/foldersAdd a new folder
/folders/{id}Update a folder
/folders/{id}Delete a folder

Groups

/groups

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

ParameterDescriptionParameter TypeData Type
name

Group name to filter by

querystring
mail

Group email to filter by

querystring
roleId

Group role ID to filter by

querystring
origin

Group origin to filter by (ad or sisense)

querystring
ids

Group IDs to filter by, separated by a comma (,) and without spaces

queryarray
fields

Whitelist of fields to return for each document. Can also define which fields to exclude by prefixing field names with -

querystring
sort

Field by which the results should be sorted. Ascending by default, descending if prefixed by -

querystring
skip

Number of results to skip from the start of the data set. To be used with the limit parameter for paging

queryinteger
limit

How many results should be returned. To be used with the skip parameter for paging

queryinteger
expand

List of fields that should be expanded (substitutes their IDs with actual objects). May be nested using the resource.subResource format

querystring

Response Class

[
  {
    "_id": "string",
    "name": "string",
    "mail": "string",
    "ad": true,
    "objectSid": "string",
    "dn": "string",
    "uSNChanged": "string",
    "created": "2015-11-15T13:39:24.591Z",
    "lastUpdated": "2015-11-15T13:39:24.591Z"
  }
]

 

Error Status Codes

HTTP Status CodeReason
200An array of groups
404resource not found
/groups/{id}

The get group by id endpoint returns the details of the user group corresponding to the id parameter.

The expandable fields for the group object are users and role.

Parameters

ParameterDescriptionParameter TypeData Type
id

The ID of the group to get.

pathstring
fields

Whitelist of fields to return for each document. Can also define which fields to exclude by prefixing field names with -

querystring
expand

List of fields that should be expanded (substitutes their IDs with actual objects). May be nested using the resource.subResource format

querystring

Response Class

{
  "_id": "string",
  "name": "string",
  "mail": "string",
  "ad": true,
  "objectSid": "string",
  "dn": "string",
  "uSNChanged": "string",
  "created": "2015-11-15T13:39:24.598Z",
  "lastUpdated": "2015-11-15T13:39:24.598Z"
}

 

Error Status Codes

HTTP Status CodeReason
200Group details
404resource not found
/groupsAdd a new group
/groups/adAdd a new Active Directory group
/groups/bulkAdd multiple groups
/groups/ad/bulkAdd multiple Active Directory groups
/groups/{id}Delete a group

LDAP Domains

/ldap_domains
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

ParameterDescriptionParameter TypeData 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

headerstring
nameName to filter the LDAP domains returned by.query

string

enabled

Filter LDAP domains according to their status enabled or disabled.

queryboolean
ids

Array of LDAP domains IDs to get, separated by a comma (,) and without spaces.

queryArray[string]
fieldsWhitelist of fields to return for each document. fields Can also define which fields to exclude by prefixing field names with -.querystring
sortField by which the results should be sorted. Ascending by default, descending if prefixed by -.querystring
skipNumber of results to skip from the start of the data set. skip is to be used with the limit parameter for paging.querynumber
limitHow many results should be returned. limit is to be used with the skip parameter for paging.querynumber
expandList of fields that should be expanded (substitures their IDs with actual objects). May be nested using the resource.subResource format.querystring

Error Status Codes

HTTP Status CodeReason
404

Invalid expand parameter.

/ldap_domains/{id}
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

ParameterDescriptionParameter TypeData 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

headerstring
id

The ID of the LDAP domain to get.

querystring
fieldsWhitelist of fields to return for each document. fields Can also define which fields to exclude by prefixing field names with -.querystring
expandList of fields that should be expanded (substitures their IDs with actual objects). May be nested using the resource.subResource format.querystring

Error Status Codes

HTTP Status CodeReason
404
  • 202 Invalid expand parameter.
  • 22001 LDAP domain not found.
/ldap_domains

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

ParameterDescriptionParameter TypeData 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

headerstring
ldapDomainBasic LDAP domain object (in JSON notation) to be added.bodyobject

Error Status Codes

HTTP Status CodeReason
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.
/ldap_domains/test

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

ParameterDescriptionParameter TypeData 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

headerstring
ldapDomainBasic LDAP domain object (in JSON notation) to be added.bodyobject

Error Status Codes

HTTP Status CodeReason
204

No response was specified

/ldap_domains/{id}/sync

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

ParameterDescriptionParameter TypeData 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

headerstring
idThe ID of the domain to updatepathstring
waitSisense should wait to sync the LDAP domain.queryboolean

Error Status Codes

HTTP Status CodeReason
204

No response was specified

/ldap_domains/{id}

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

ParameterDescriptionParameter TypeData 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

headerstring
id

The ID of the LDAP domain to update.

pathstring
fieldsPartial LDAP Domain object (in JSON notation) containing the fields to updatebodyobject

Error Status Codes

HTTP Status CodeReason
404

2001 User not found.

/ldap_domains/bulk

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

ParameterDescriptionParameter TypeData 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

headerstring
id

Array of LDAP domain IDs to delete, separated by a comma (,) and without spaces.

queryArray[string]

Error Status Codes

HTTP Status CodeReason
204

No response was specified

40422001 One or more LDAP domains were not found.

Live Connectors

/live_connectors

The get live connectors endpoint returns a list of connectors.

ParameterDescriptionParameter TypeData 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

headerstring

Error Status Codes

HTTP Status CodeReason
404API not found
/live_connectors/{provider}

The get live connectors endpoint returns a list of connectors.

ParameterDescriptionParameter TypeData 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

headerstring
providerThe name of live connector providerpathstring

Error Status Codes

HTTP Status CodeReason
404API not found
/live_connectors/{provider}/count

The get table count endpoint returns the number of entries in a specified table.

ParameterDescriptionParameter TypeData 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

headerstring
providerThe name of live connector providerpathstring
connectionParametersThe connection parameters for a specific datasourcebody 

Error Status Codes

HTTP Status CodeReason
404API not found
/live_connectors/{provider}/table_preview

The get table preview endpoint returns a preview of the data in specified table.

ParameterDescriptionParameter TypeData 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

headerstring
providerThe name of live connector providerpathstring
connectionParametersThe connection parameters for a specific datasourcebody 

Error Status Codes

HTTP Status CodeReason
404API not found
/live_connectors/{provider}/list_databases

The list databases endpoint returns a list of available databases in the connected instance.

ParameterDescriptionParameter TypeData 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

headerstring
providerThe name of live connector providerpathstring
connectionParametersThe connection parameters for a specific datasourcebody 

Error Status Codes

HTTP Status CodeReason
404API not found
/live_connectors/{provider}/test_connection

The test_connection endpoint Opens a connection through a specified connector to the datasource.

ParameterDescriptionParameter TypeData 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

headerstring
providerThe name of live connector providerpathstring
connectionParametersThe connection parameters for a specific datasourcebody 

Error Status Codes

HTTP Status CodeReason
404API not found
/live_connectors/{provider}/list_table_schemas

The list table schemas endpoint returns a list of available tables in a specified database. Table schemas do not include column details.

ParameterDescriptionParameter TypeData 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

headerstring
providerThe name of live connector providerpathstring
connectionParametersThe connection parameters for a specific datasourcebody 

Error Status Codes

HTTP Status CodeReason
404API not found
/live_connectors/{provider}/table_schema_details

The list table schemas endpoint returns a list of available tables in a specified database. Table schemas do not include column details.

ParameterDescriptionParameter TypeData 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

headerstring
providerThe name of live connector providerpathstring
connectionParametersThe connection parameters for a specific datasourcebody 

Error Status Codes

HTTP Status CodeReason
404API not found

Logs

/logs/timer

The post timer endpoint returns information regarding your dashboard’s loading times.

 

Oauth

/oauth/{service}/login_uri

The get login uri endpoint returns uri for service login without redirect_uri param. It should be generated at client side.

ParameterDescriptionParameter TypeData 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

headerstring
serviceThe name of servicepathstring

Error Status Codes

HTTP Status CodeReason
404API not found
/oauth/{service}/auth

The authorize endpoint returns tokens for specific client code.

ParameterDescriptionParameter TypeData 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

headerstring
serviceThe name of servicepathstring
bodyContains code and redirectUri parametersbody 

Error Status Codes

HTTP Status CodeReason
404API not found

Reporting

/reporting

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

ParameterDescriptionParameter TypeData 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

headerstring
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.

body
{
  "assetId": "string",
  "assetType": "dashboard",
  "recipients": [
    {
      "type": "user",
      "recipient": "string"
    }
  ],
  "preferences": {
    "inline": true,
    "pdf": {
      "includeTitle": true,
      "includeFilters": true,
      "includeDS": true,
      "renderingInfo": {
        "paperFormat": "A3",
        "paperOrientation": "portrait",
        "layout": "asis"
      }
    }
  }
}
fields

Whitelist of fields to return for each document. You can also define which fields to exclude by prefixing field names with -

querystring
expand

List of fields that should be expanded (substitutes their IDs with actual objects). May be nested using the resource.subResource format

querystring

Error Status Codes

HTTP Status CodeReason
204

Send report operation was successful

Settings

/settings/sso

The sso settings used for single sign on configuration.

Error Status Codes

HTTP Status CodeReason
403Forbidden
404Name not found
/settings/system

The system settings used for system settings configuration.

Error Status Codes

HTTP Status CodeReason
400System settings are empty
403Forbidden
404Name not found
/settings/email_server

The email server settings used for Email Server settings managing.

Error Status Codes

HTTP Status CodeReason
404Email server does not exist
/settings/globalization

The globalization endpoint returns locale settings, including the set locale, and whether autodetect is enabled.

ParameterDescriptionParameter TypeData 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

headerstring

Error Status Codes

HTTP Status CodeReason
404Not configured yet
/settings/public_settings

The Public Configuration used for getting public system settings.

/settings/sso

The sso settings used for single sign on configuration.

ParameterDescriptionParameter TypeData 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

headerstring
sso

Object with the sso settings

body 

Error Status Codes

HTTP Status CodeReason
400Invalid input
403Forbidden
/settings/system

The system settings used for system settings configuration.

ParameterDescriptionParameter TypeData 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

headerstring
emailServer

Object with the system settings

body 

Error Status Codes

HTTP Status CodeReason
400Invalid input
403Forbidden
/settings/email_server

The email server settings used for Email Server settings managing.

ParameterDescriptionParameter TypeData 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

headerstring
emailServer

Object with the system settings

body 

Error Status Codes

HTTP Status CodeReason
400
  • 7501 Email server settings already exists
/settings/globalization

You can change the locale or select whether the localization selection is automatically detected or not.

ParameterDescriptionParameter TypeData 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

headerstring
globalization

Object with the globalization settings.

body 

Error Status Codes

HTTP Status CodeReason
400

Invalid input

403Forbidden
/settings/globalization

You can update the locale or select whether the localization selection is automatically detected or not.

ParameterDescriptionParameter TypeData 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

headerstring
globalization

Object with the globalization settings.

body 

Error Status Codes

HTTP Status CodeReason
400

Invalid input

403Forbidden
/settings/email_server

The email server settings used for Email Server settings managing.

ParameterDescriptionParameter TypeData 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

headerstring
emailServer

Object with the settings of email server

body 

Error Status Codes

HTTP Status CodeReason
400

Invalid input

403Forbidden
/settings/email_server

The delete email server settings delete your email server settings.

/settings/globalization

Deletes globalization settings in your server.

ParameterDescriptionParameter TypeData 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

headerstring

Error Status Codes

HTTP Status CodeReason
400

Invalid input

403Not configured yet

Shares

/dashboards/{dashboardId}/shares

The get shares endpoint returns a dashboard's share configurations.

The expandable fields for the shares object are group and user.

Parameters

ParameterDescriptionParameter TypeData 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

headerstring
dashboardId

The ID of the dashboard who's shares to get.

pathstring
fields

Whitelist of fields to return for each document. Can also define which fields to exclude by prefixing field names with -

querystring
expand

List of fields that should be expanded (substitutes their IDs with actual objects). May be nested using the resource.subResource format

querystring

Response Class

[
  {
    "shareId": "string",
    "type": "user",
    "rule": "view",
    "subscribe": true
  }
]

 

Error Status Codes

HTTP Status CodeReason
200An array of the dashboard's sharing configurations
404expand resource not found
/dashboards/{dashboardId}/shares/{id}

The get share by id endpoint returns the details of a specific share of the dashboard.

The expandable fields for the shares object are group and user.

Parameters

ParameterDescriptionParameter TypeData 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

headerstring
dashboardId

The ID of the dashboard to get.

pathstring
id

The ID of the share to get.

pathstring
fields

Whitelist of fields to return for each document. Can also define which fields to exclude by prefixing field names with -

querystring
expand

List of fields that should be expanded (substitutes their IDs with actual objects). May be nested using the resource.subResource format

querystring

Response Class

{
  "shareId": "string",
  "type": "user",
  "rule": "view",
  "subscribe": true
}

 

Error Status Codes

HTTP Status CodeReason
200A dashboard share configuration
404expand resource not found

Translations

/translations

The get translations endpoint returns a list of all your supported languages in Sisense.

Parameters

ParameterDescriptionParameter TypeData 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

headerstring

Error Status Codes

HTTP Status CodeReason
404Language not found
/translations/{lang}

The get translations language ndpoint returns a language file.

Parameters

ParameterDescriptionParameter TypeData 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

headerstring

Error Status Codes

HTTP Status CodeReason
404Language not found

Users

/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

ParameterDescriptionParameter TypeData 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

headerstring
userName

Username to filter by

querystring
email

Email to filter by

querystring
firstName

First name to filter by

querystring
lastName

Last name to filter by

querystring
roleId

Role ID to filter by

querystring
groupId

Group ID to filter by

querystring
active

User state to filter by - true for active users, false for inactive users

queryboolean
origin

User origin to filter by - ad for active directory or sisense

querystring
ids

Array of user IDs to get, separated by a comma (,) and without spaces

queryarray
fields

Whitelist of fields to return for each document. Can also define which fields to exclude by prefixing field names with -

querystring
sort

Field by which the results should be sorted. Ascending by default, descending if prefixed by -

querystring
skip

Number of results to skip from the start of the data set. To be used with the limit parameter for paging

queryinteger
limit

How many results should be returned. To be used with the skip parameter for paging

queryinteger
expand

List of fields that should be expanded (substitutes their IDs with actual objects). May be nested using the resource.subResource format

querystring

Response Class

[
  {
    "_id": "string",
    "email": "string",
    "userName": "string",
    "firstName": "string",
    "lastName": "string",
    "roleId": "string",
    "active": true,
    "groups": [
      "string"
    ],
    "adgroups": [
      "string"
    ],
    "activeDirectory": true,
    "principalName": "string",
    "objectSid": "string",
    "uSNChanged": "string",
    "dn": "string",
    "preferences": {},
    "created": "2015-11-15T13:39:24.613Z",
    "lastLogin": "string",
    "lastUpdated": "2015-11-15T13:39:24.613Z",
    "pendingExpiration": "2015-11-15T13:39:24.613Z"
  }
]

 

Error Status Codes

HTTP Status CodeReason
200An array of users
404expand resource not found
/users/{id}

The get user by ID endpoint retrieves a specific user object corresponding to the provided ID.

The expandable fields for the user object are groups, adgroups and role.

Parameters

ParameterDescriptionParameter TypeData 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

headerstring
id

The ID of the user to get

pathstring
fields

Whitelist of fields to return for each document. Can also define which fields to exclude by prefixing field names with -

querystring
expand

List of fields that should be expanded (substitutes their IDs with actual objects). May be nested using the resource.subResource format

querystring

Response Class

{
  "_id": "string",
  "email": "string",
  "userName": "string",
  "firstName": "string",
  "lastName": "string",
  "roleId": "string",
  "active": true,
  "groups": [
    "string"
  ],
  "adgroups": [
    "string"
  ],
  "activeDirectory": true,
  "principalName": "string",
  "objectSid": "string",
  "uSNChanged": "string",
  "dn": "string",
  "preferences": {},
  "created": "2015-11-15T13:39:24.622Z",
  "lastLogin": "string",
  "lastUpdated": "2015-11-15T13:39:24.622Z",
  "pendingExpiration": "2015-11-15T13:39:24.622Z"
}

 

Error Status Codes

HTTP Status CodeReason
200user
404resource not found
/users

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

ParameterDescriptionParameter TypeData 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

headerstring
user

Basic user object (in JSON notation) to be added

body
{
  "email": "string",
  "userName": "string",
  "firstName": "string",
  "lastName": "string",
  "roleId": "string",
  "groups": [
    "string"
  ],
  "preferences": {},
  "password": "string"
}

Error Status Codes

HTTP Status CodeReason
201No response was specified
/users/ad

The add AD user endpoint receives an AD user object, retrieves the user's details from Active Directory and adds him to the application.

Parameters

ParameterDescriptionParameter TypeData 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

headerstring
adUser

AD user object to be added

body
{
  "userName": "string",
  "roleId": "string",
  "groups": [
    "string"
  ],
  "objectSid": "string",
  "preferences": {}
}

Error Status Codes

HTTP Status CodeReason
201No response was specified
/users/bulk

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

ParameterDescriptionParameter TypeData 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

headerstring
users

A collection of basic user objects (in JSON notation) to be added

body
[
  {
    "email": "string",
    "userName": "string",
    "firstName": "string",
    "lastName": "string",
    "roleId": "string",
    "groups": [
      "string"
    ],
    "preferences": {},
    "password": "string"
  }
]

Error Status Codes

HTTP Status CodeReason
201No response was specified
/users/ad/bulk

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

ParameterDescriptionParameter TypeData 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

headerstring
adUsers

Array of AD user objects to be added

body
[
  {
    "userName": "string",
    "roleId": "string",
    "groups": [
      "string"
    ],
    "objectSid": "string",
    "preferences": {}
  }
]

Error Status Codes

HTTP Status CodeReason
201No response was specified
/users/{id}Update a user
/users/bulk

Delete multiple users

/users/{id}Delete a user

Widgets

/dashboards/{dashboardId}/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

ParameterDescriptionParameter TypeData 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

headerstring
dashboardId

The ID of the dashboard to get

pathstring
title

Widget title to filter by

querystring
type

Widget type to filter by

querystring
subtype

Widget sub-type to filter by

querystring
fields

Whitelist of fields to return for each document. Can also define which fields to exclude by prefixing field names with -

querystring
sort

Field by which the results should be sorted. Ascending by default, descending if prefixed by -

querystring
skip

Number of results to skip from the start of the data set. To be used with the limit parameter for paging

queryinteger
limit

How many results should be returned. To be used with the skip parameter for paging

queryinteger

Response Class

[
  {
    "title": "string",
    "oid": "string",
    "datasource": {
      "title": "string",
      "id": "string",
      "address": "string",
      "database": "string"
    },
    "type": "string",
    "subtype": "string",
    "dashboardid": "string",
    "owner": "string",
    "userId": "string",
    "instanceType": "string",
    "lastUpdated": "2015-11-15T13:39:24.518Z",
    "metadata": {
      "panels": [
        {
          "name": "string",
          "items": [
            {
              "jaql": {
                "dim": "string",
                "datatype": "string",
                "title": "string"
              },
              "field": {
                "id": "string",
                "index": 0
              },
              "format": {}
            }
          ]
        }
      ]
    },
    "shares": [
      {
        "shareId": "string",
        "type": "user",
        "rule": "view",
        "subscribe": true
      }
    ]
  }
]

 

Error Status Codes

HTTP Status CodeReason
200An array of widgets
/dashboards/{dashboardId}/widgets/{id}

The get dashboard widget by ID endpoint returns a specific widget (by ID) from a specific dashboard.

Parameters

ParameterDescriptionParameter TypeData 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

headerstring
dashboardId

The ID of the dashboard containing the widget

pathstring
id

The ID of the widget to get

pathstring
fields

Whitelist of fields to return for each document. Can also define which fields to exclude by prefixing field names with -

querystring

Response Class

{
  "title": "string",
  "oid": "string",
  "datasource": {
    "title": "string",
    "id": "string",
    "address": "string",
    "database": "string"
  },
  "type": "string",
  "subtype": "string",
  "dashboardid": "string",
  "owner": "string",
  "userId": "string",
  "instanceType": "string",
  "lastUpdated": "2015-11-15T13:39:24.532Z",
  "metadata": {
    "panels": [
      {
        "name": "string",
        "items": [
          {
            "jaql": {
              "dim": "string",
              "datatype": "string",
              "title": "string"
            },
            "field": {
              "id": "string",
              "index": 0
            },
            "format": {}
          }
        ]
      }
    ]
  },
  "shares": [
    {
      "shareId": "string",
      "type": "user",
      "rule": "view",
      "subscribe": true
    }
  ]
}

 

Error Status Codes

HTTP Status CodeReason
200The widget with the given ID
/dashboards/{dashboardId}/widgets/{id}/export/png

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

ParameterDescriptionParameter TypeData 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

headerstring
dashboardId

The ID of the dashboard containing the widget

pathstring
id

The ID of the widget to export

pathstring
width

Render width in pixels

querystring
height

Render height in pixels

querystring

 

Error Status Codes

HTTP Status CodeReason
200Image file
/dashboards/{dashboardId}/widgets

The add widget to dashboard endpoint adds the provided widget object to the dashboard of the given ID.

Parameters

ParameterDescriptionParameter TypeData 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

headerstring
dashboardId

The ID of the dashboard to add the widget to

pathstring
widget

Basic widget object to be added to the dashboard

body
{
  "title": "string",
  "datasource": {
    "title": "string",
    "id": "string",
    "address": "string",
    "database": "string"
  },
  "type": "string",
  "subtype": "string",
  "metadata": {
    "panels": [
      {
        "name": "string",
        "items": [
          {
            "jaql": {
              "dim": "string",
              "datatype": "string",
              "title": "string"
            },
            "field": {
              "id": "string",
              "index": 0
            },
            "format": {}
          }
        ]
      }
    ]
  }
}

Error Status Codes

HTTP Status CodeReason
201No response was specified
/dashboards/{dashboardId}/widgets/{id}

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

ParameterDescriptionParameter TypeData 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

headerstring
dashboardId

The ID of the dashboard to add the widget to

pathstring
idThe ID of the widget to updatepathstring
widget

Basic widget object to be added to the dashboard

body
{
  "title": "string",
  "oid": "string",
  "datasource": {
    "title": "string",
    "id": "string",
    "address": "string",
    "database": "string"
  },
  "type": "string",
  "subtype": "string",
  "dashboardid": "string",
  "owner": "string",
  "userId": "string",
  "instanceType": "string",
  "lastUpdated": "2015-11-15T13:39:24.448Z",
  "metadata": {
    "panels": [
      {
        "name": "string",
        "items": [
          {
            "jaql": {
              "dim": "string",
              "datatype": "string",
              "title": "string"
            },
            "field": {
              "id": "string",
              "index": 0
            },
            "format": {}
          }
        ]
      }
    ]
  },
  "shares": [
    {
      "shareId": "string",
      "type": "user",
      "rule": "view",
      "subscribe": true
    }
  ]
}

Error Status Codes

HTTP Status CodeReason
201No response was specified
/dashboards/{dashboardId}/widgets/{id}

The delete widget endpoint will delete the widget with the provided ID from it's dashboard.

Parameters

ParameterDescriptionParameter TypeData 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

headerstring
dashboardId

The ID of the dashboard containing the widget

pathstring
id

The ID of the widget to delete

pathstring

Error Status Codes

HTTP Status CodeReason
200Delete operation was successful

 

 

The login endpoint validates passed credentials and returns an API token for subsequent requests to the API.

Response Class

{
  "success": true,
  "message": "string",
  "access_token": "string",
  "profile": {}
}

 

Error Status Codes

HTTP Status CodeReason
401Unauthorized: Invalid credentials. Wrong username or password.