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 2 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 him.

Parameters

ParameterDescriptionParameter TypeData Type
emailObj

Email of the user to activate

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

Error Status Codes

HTTP Status CodeReason
204email successfuly sent
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 emails of users to activate

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

Error Status Codes

HTTP Status CodeReason
204email successfuly sent
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 him.

Parameters

ParameterDescriptionParameter TypeData Type
emailObject

email of the user who's password to reset

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

Error Status Codes

HTTP Status CodeReason
204email successfuly sent
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 successfuly
404Reset token is invalid

Admin

GET/dashboards/adminAvailable from Sisense V6.2
POST/dashboards/{id}/admin/change_ownerAvailable from Sisense V6.2
POST/dashboards/{server}/{title}/replaceDatasourceAvailable from Sisense V6.2

Application

GET/application/status
 Get the application's status

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

Response Class

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

 

Error Status Codes

HTTP Status CodeReason
200Current application status

Authentication

POST/authentication/login

Available from Sisense V6.2

 Get the application's status

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
401Unathorized: 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 keywoard 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 (substitures 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 keywoard 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 (substitures 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 endpoind 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 keywoard 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 endpoind 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 keywoard 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 keywoard 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 keywoard 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 (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
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 keywoard 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 keywoard 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 keywoard 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 keywoard 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 keywoard 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 keywoard 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

Available from Sisense V6.2

 Duplicate 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 keywoard 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

Available from Sisense V6.2

 Duplicate 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 keywoard 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 successfull

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 keywoard 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_ownerAvailable from Sisense V6.2
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 keywoard 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 keywoard 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 keywoard 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 keywoard 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 successfull
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 keywoard 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

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 (substitures 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 (substitures 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/groupsAvailable from Sisense V6.2
POST/groups/adAvailable from Sisense V6.2
POST/groups/bulkAvailable from Sisense V6.2
POST/groups/ad/bulkAvailable from Sisense V6.2
DELETE/groups/{id}Available from Sisense V6.2

Reporting

POST/reportingAvailable from Sisense V6.2

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 keywoard 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 (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
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 keywoard 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

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 keywoard 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 (substitures 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 keywoard 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 (substitures 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 keywoard 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 keywoard 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 keywoard 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 keywoard 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}Available from Sisense V6.2
DELETE/users/bulkAvailable from Sisense V6.2
DELETE/users/{id}Available from Sisense V6.2

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 keywoard 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 keywoard 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 keywoard 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 keywoard 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 keywoard 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 keywoard 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

 


  • No labels