Skip to end of metadata
Go to start of metadata

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

Compare with Current View Page History

« Previous Version 23 Next »

Base URL

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

GET/account/activate/{token}
 Validate activation 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
GET/account/reset_password/{token}
 Validate password reset 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
POST/account/begin_activate
 Begin user activation

The begin activation endpoint is the starting point for the user activation process. It generates a temporary activation token for the user associated with the provided email address and sends an activation email to them.

Parameters

ParameterDescriptionParameter TypeData Type
emailObj

The email address of the user to be activated.

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

Error Status Codes

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

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
Object [ schema ]:
{
  "password": "string"
}

Error Status Codes

HTTP Status CodeReason
204User activated successfully
404Invalid activation token
POST/account/begin_activate_bulk
 Bulk begin user activation

The bulk begin activation endpoint is the starting point for the user activation process when activating multiple users. It generates a temporary activation token for the users associated with the provided email addresses and sends an activation email to them.

Parameters

ParameterDescriptionParameter TypeData Type
emailList

The list of user emails to be activated.

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

Error Status Codes

HTTP Status CodeReason
204Email sent successfully
404Invalid email
POST/account/begin_reset_password
 Begin reset password process

The begin reset password endpoint is the starting point for the password reset process. It generates a temporary password reset token for the user associated with the provided email address and sends a password reset email to them.

Parameters

ParameterDescriptionParameter TypeData Type
emailObject

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

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

Error Status Codes

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

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
Object [ schema ]:
{
  "password": "string"
}

Error Status Codes

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

Admin

GET/dashboards/admin
 Get all dashboards

The get all dashboards endpoint provides access to all available dashboards in their stored format as JSON objects. 
Its results can be filtered by parameters such as dashboard type, dashboard name, parent folder, or datasource. 

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
POST/dashboards/{id}/admin/change_owner
 Change dashboard 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
Object [ schema ]:
{
 "ownerId": "string",
 "originalOwnerRule": "edit"
}
POST/dashboards/{server}/{title}/replaceDatasource
 Replace Data Source

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
Object [ schema ]:
{
  "title": "string",
  "id": "string",
  "address": "string",
  "database": "string",
  "fullname": "string"
}

Alerts

GET/alerts
 Get 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
GET/alerts/{id}
 Get a specific alert

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
GET

/alerts/count

 Get the amount of alerts for a user

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

Parameters

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
POST/alerts
 Add a new alert

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
PATCH/alerts/{id}
 Update an alert

The update alert endpoint performs a partial update on the alert of the defined ID, updating the fields in the alert object defined in the body. The fields that can be updated are name, enabled, message, parties, action, context.

Parameters

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
PATCH/alerts/{id}/setReceiveNotification
 Update alert's disabled users

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

Parameters

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
DELETE/alerts/{id}
 Delete an alert

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

GET/analytics/token
 Get token for Sisense Analytics

Returns a token used to authenticate Sisense Analytics API calls.

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
GET/analytics/token/revoke
 Revoke token for Sisense Analytics

Revoke the token used to authenticate your Sisense Analytics API calls.

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
GET/analytics/collection/{collection}
 Get the entire collection based on the received parameter

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

Parameters

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
collectionCollection name to be returned.pathstring

Application

GET/application/status
 Get the application's status

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

 

Response Class

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

 

Error Status Codes

HTTP Status CodeReason
200Current application status

Authentication

POST/authentication/login
 Authenticate and receive token

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.

Dashboards

GET/dashboards
 Get a user's dashboards

The get dashboards endpoint provides access to a specified user's dashboards in their stored format as JSON objects.
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
GET/dashboards/{id}
 Get a specific dashboard

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
GET/dashboards/{id}/export/png
 Get a dashboard as .png image

The export dashboard to .png endpoint returns the requested dashboard rendered as a .png image file.
It can be configured to export images of different width, and to include or exclude certain parts (such as dashboard filters).
Note that dashboards rendered this way have a different layout to dashboards displayed in the application, called the reporting layout.

Parameters

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
GET/dashboards/{id}/export/pdf
 Get a dashboard as .pdf file

The export dashboard to .pdf endpoint returns the requested dashboard rendered as a .pdf document file.
It can be configured to export PDFs of different paper sizes, orientation, as well as to include or exclude certain parts (such as dashboard filters).
Note that dashboards rendered this way have a different layout to dashboards displayed in the application, and can be either the as is layout (the reporting layout) or the feed layout which puts each widget in it's own line.

Parameters

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
GET/dashboards/{id}/export/dash
 Get a dashboard as .dash file

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

Parameters

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
GET/dashboards/{dashboardId}/shares
 Get a dashboard's shares

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

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

Parameters

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
GET/dashboards/{dashboardId}/widgets
 Get a dashboard's widgets

The get dashboard widgets endpoint returns an array of a dashboard's widgets.
The result can be filtered by different parameters such as the widget type or title.

Parameters

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
GET/dashboards/{dashboardId}/shares/{id}
 Get a dashboard's specific share configuration

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
GET/dashboards/{dashboardId}/widgets/{id}
 Get a specific widget from a dashboard

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
GET/dashboards/{dashboardId}/widgets/{id}/export/png
 Get a specific widget as .png image

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
POST/dashboards
 Add a new dashboard

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
Object [ schema ]:
{
  "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
POST/dashboards/import
 Import a dashboard

The import dashboard endpoint receives a .dash file containing a Sisense dashboard and creates it in 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
Object [ schema ]:
{
  "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
POST/dashboards/{id}/publish
 Publish a dashboard

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


POST/dashboards/{id}/restore
 Restore a dashboard

The restore dashboard endpoint negates all changed made to the dashboard and takes the latest published version.

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 restore

pathstring

Error Status Codes

HTTP Status CodeReason
204

Operation was successful

404

Dashboard not found

POST

 

/dashboards/{id}/duplicate
 Duplicate a dashboard

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
POST/dashboards/{id}/change_owner
 Change dashboard owner

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

Response

 

Object [ schema ]:
{
  "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
Object [ schema ]:
{
  "ownerId": "string",
  "originalOwnerRule": "edit"
}
POST/dashboards/{dashboardId}/widgets
 Add a new widget to a dashboard

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

Parameters

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
Object [ schema ]:
{
  "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
PATCH/dashboards/{id}
 Add a new widget to a dashboard

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
Object [ schema ]:
{
  "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 
PATCH/dashboards/{dashboardId}/widgets/{id}
 Add a new widget to a dashboard

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
Object [ schema ]:
{
  "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
DELETE/dashboards/{id}
 Delete a dashboard

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
DELETE/dashboards/{dashboardId}/widgets/{id}
 Delete a widget

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 successfull

Features

GET/features
 Return a list of 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
PATCH/features/{key}/toggle
 Toogles a feature on or off

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

ElastiCubes

GET/elasticubes/setsGet ElastiCube sets
GET/elasticubes/sets/{title}Get ElastiCube set
POST

/elasticubes/sets

Add ElastiCube set
PATCH/elasticubes/sets/{title}Update ElastiCube set
DELETE/elasticubes/sets/{title}Delete ElastiCube set

Folders

GET/folders

Get all folders

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

Groups

GET/groups
 Get 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
GET/groups/{id}
 Get a specific group

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
POST/groupsAdd a new group
POST/groups/adAdd a new Active Directory group
POST/groups/bulkAdd multiple groups
POST/groups/ad/bulkAdd multiple Active Directory groups
DELETE/groups/{id}Delete a group

LDAP Domains

GET/ldap_domains
 Get 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.

GET/ldap_domains/{id}
 Get a specific LDAP domain
The get LDAP domain by ID endpoint retrieves a specific LDAP domain object corresponding to the provided ID. The expandable fields for the LDAP domain object is users.

Parameters

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.
POST/ldap_domains
 Add a new LDAP Domain

The add LDAP Domain endpoint receives a new LDAP Domain object and creates that domain in Sisense, returning the created object.

If a domain with the same name or baseDN exists, Sisense returns an error.

Parameters

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.
POST/ldap_domains/test
 Test LDAP Domain

The test LDAP Domain endpoint receives an LDAP Domain object and tests it against the LDAP server.

If the LDAP server is not responding/wrong credentials were sent, Sisense will return an error.

Parameters

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

POST/ldap_domains/{id}/sync
 Sync LDAP Domain

The sync LDAP Domain endpoint receives an LDAP Domain ID and synchronize it against the LDAP server.

If a the LDAP server is not responding, Sisense will return an error.

Parameters

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

PATCH/ldap_domains/{id}
 Update a LDAP domain

The update LDAP Domain endpoint receives a domain id and what fields to update, returning the updated object.

If a domain with the specified id is not exists, Sisense returns an error.

Parameters

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.

DELETE/ldap_domains/bulk
 Delete LDAP domains

The delete LDAP Domains endpoint receives a list of domain IDs and deletes these domains in Sisense.

If a domain with the specified id does not exists, Sisense returns an error.

Parameters

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.

Reporting

POST/reporting
 Send an email report

The send report endpoint receives asset info and recipients list and sends an email report. Note: the users and groups in the recipients section must be shared to the dashboard.

Parameters

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

Shares

GET/dashboards/{dashboardId}/shares
 Get a dashboard's shares

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

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

Parameters

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
GET/dashboards/{dashboardId}/shares/{id}
 Get a dashboard's specific share configuration

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

Users

GET/users
 Get users

The get users endpoint returns a list of users with their details.
Results can be filtered by parameters such as username and email.

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

Parameters

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
GET/users/{id}
 Get a specific user

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
POST/users
 Add a new user

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
Object [ schema ]:
{
  "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
POST/users/ad
 Add a new Active Directory user

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
Object [ schema ]:
{
  "userName": "string",
  "roleId": "string",
  "groups": [
    "string"
  ],
  "objectSid": "string",
  "preferences": {}
}

Error Status Codes

HTTP Status CodeReason
201No response was specified
POST/users/bulk
 Add several users at once

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
Object [ schema ]:
[
  {
    "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
POST/users/ad/bulk
 Bulk add Active Directory users

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
Object [ schema ]:
[
  {
    "userName": "string",
    "roleId": "string",
    "groups": [
      "string"
    ],
    "objectSid": "string",
    "preferences": {}
  }
]

Error Status Codes

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

Delete multiple users

DELETE/users/{id}Delete a user

Widgets

GET/dashboards/{dashboardId}/widgets
 Get a dashboard's widgets

The get dashboard widgets endpoint returns an array of a dashboard's widgets.
The result can be filtered by different parameters such as the widget type or title.

Parameters

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
GET/dashboards/{dashboardId}/widgets/{id}
 Get a specific widget from a dashboard

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
GET/dashboards/{dashboardId}/widgets/{id}/export/png
 Get a specific widget as .png image

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
POST/dashboards/{dashboardId}/widgets
 Add a new widget to a dashboard

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

Parameters

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
Object [ schema ]:
{
  "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
PATCH/dashboards/{dashboardId}/widgets/{id}
 Add a new widget to a dashboard

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
Object [ schema ]:
{
  "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
DELETE/dashboards/{dashboardId}/widgets/{id}
 Delete a widget

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
  • No labels