Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

REST API operations are available for the following categories:

Table of Contents
maxLevel1

...

ElastiCubes

...

Metadata

...

Status
colourBlue
titleGET

...

Expand
titleReturns a list of ElastiCubes with metadata.

Metadata includes the ElastiCube name, ElastiCube ID, the server address (URL), and the database name.

Parameters

ParameterDescriptionData Type
q

A query that returns all ElastiCubes beginning with the value. For example, a value of 'sa' will return ElastiCubes called 'Sample Ecommerce', 'Sample Lead generation' etc.

string
sortByThe order in which the ElastiCubes appear in the response (natural, title, lastupdatetime, createtime)string
Code Block
titleResponse
 [
  {
    "title": "string",
    "id": "ObjectId",
    "address": "string",
    "database": "string"
  }
]

Properties

PropertyDescription
titleThe name of the ElastiCube.
idThe ID of the ElastiCube.
addressThe ElastiCube server address
databaseThe name of the database

Error Status Codes

HTTP Status CodeReason
403forbidden

...

Status
colourBlue
titleGET

...

Expand
titleReturns metadata for an ElastiCube by ElastiCube name.

Metadata includes the ElastiCube name, ElasticCube ID, server address, and database name.

Parameters

Parameter
Value
Description
Data Type
elasticubemandatoryThe ElastiCube's name.string
Code Block
titleResponse
 {
  "title": "string",
  "id": "objectId",
  "address": "string",
  "database": "string"
}

Properties

Property
Description
titleThe name of the ElastiCube.
idThe ID of the ElastiCube.
addressThe ElastiCube server address.
databaseThe name of the database.

Error Status Codes

HTTP Status Code
Reason
400invalid elasticube identifier
403forbidden

...

Status
colourBlue
titleGET

...

/elasticubes/metadata/{elasticube}/fields

...

Expand
titleReturns fields included in a specific ElastiCube.

Returns field details including the related column and table.

Parameters

Parameter
Value
Description
Data Type
elasticubemandatoryThe name of the ElastiCubestring
q Enter a specific query to return only fields that include the query string.string
offset Defines how many items to skip before returning the results. For example, to return results from value #101 onward, enter a value of ‘100’.int
count 

Limits the result set to a defined number of results. Enter 0 (zero) or leave blank not to limit.

int
Code Block
titleResponse
[
  {
    "id": "string",
    "type": "string",
    "dimtype": "string",
    "title": "string",
    "table": "string",
    "column": "string",
    "merged": bool,
    "indexed": bool
  },
]

Properties

PropertyDescription
idInternal reference
typeThe type of field, for example, 'dimension'.
dimtypeThe type of dimension, for example: text, date-time, etc.
titleThe field name.
tableThe table name.
columnThe column name.

Error Status Codes

HTTP Status Code
Reason
400invalid ElastiCube identifier
403forbidden

...

Status
colourBlue
titleGET

...

/elasticubes/{elasticube}/Sql

...

Expand
titleExecutes an SQL statement to extract data from an ElastiCube.

Parameters

Parameter
Value
Description
Data Type
elasticubemandatoryThe name of the ElastiCubestring
offset 

Defines how many items to skip before returning the results. For example, to return results from value #101 onward, enter a value of ‘100’.

int
count 

Limits the result set to a defined number of results. Enter 0 (zero) or leave blank not to limit.

int
format The format in which the results are returned. string
query The SQL statement to execute.string
Code Block
titleResponse
 

Error Status Codes

HTTP Status Code
Reason
400invalid elasticube identifier
403forbidden

...

Status
colourBlue
titleGET

...

Expand
titleReturns ElastiCubes with their server and ElastiCube details.

Returns ElastiCubes with their server and ElastiCube details.

Parameters

Parameter
Value
Description
Data Type
q A query that returns all ElastiCubes beginning with the value. For example, a value of 'sa' will return ElastiCubes called 'Sample Ecommerce', 'Sample Lead generation', etc.string
offset Defines how many items to skip before returning the results. For example, to return results from value #101 onward, enter a value of ‘100’.int
count 

Limits the result set to a defined number of results. Enter 0 (zero) or leave blank not to limit.

int
direction The sort direction of the results.string
withPermissions Include ElastiCube permissions.bool
Code Block
titleResponse
[
  {
    "address": "string",
    "cubes": [],
    "permissionsSummary": int
  }
]

Properties

PropertyDescription
addressThe ElastiCube address.
cubesAn array that includes metadata for each ElastiCube.
createdUtcThe date on which the ElastiCube was created.
databaseNameThe name of the database.
lastBuiltUtcThe last build date.
permissionsSummaryA list of permissions.
sizeInMbThe size of the ElastiCube in MB.
status

The status of the ElastiCube:

1 - stopped

2 - running

4 - faulted

8 - being deleted

16 - currently restarting

32 - wrong version

64 - the ElastiCube is down because it is 32 bit data on a 64 bit codebase

128 - the ElastiCube is down because it is 64 bit data on a 32 bit codebase

256 - locked

512 - the ElastiCube or its child is currently in a build process.

1024 - the ElastiCube is starting, but not yet running.

2048 - the ElastiCube is in a build process.

4096 - trying to import a BigData ElastiCube on a non-BigData server

8192 - trying to import a non-BigData ElastiCube on a BigData server

16384 - Building is finished, now post indexing is running

32768 - the ElastiCube is being stopped but its executable is still running

65536 - this ElastiCube is in the process of cancelling an in-progress build

titleThe name of the ElastiCube.

Error Status Codes

HTTP Status Code
Reason
403forbidden

...

Status
colourBlue
titleGET

...

Expand
titleReturns the ElastiCube servers with metadata.

Parameters

Parameter
Value
Description
Data Type
q Enter a search query to return results containing the querystring
offset 

Defines how many items to skip before returning the results. For example, to return results from value #101 onward, enter a value of ‘100’.
Enter 0 (zero) or leave blank not to limit.

int
count Limit the result set to a defined number of results.int
direction The sort direction.string
withPermissions 

Includes a list of permissions.

bool
Code Block
titleResponse
[
  {
    "address": "string",
    "permissionsSummary": int
  }
]

Properties

PropertyDescription
addressThe ElastiCube address.
permissionsSummaryA list of permissions.

Error Status Codes

HTTP Status Code
Reason
403forbidden

...

Status
colourBlue
titleGET

...

Expand
titleReturns all the ElastiCubes by server.

Parameters

Parameter
Value
Description
Data Type
serverMandatoryThe server addressstring
q 

A query that returns all ElastiCubes beginning with the value. For example, a value of 'sa' will return ElastiCubes called 'Sample Ecommerce', 'Sample Lead generation' etc.

string
offset Defines how many items to skip before returning the results. For example, to return results from value #101 onward, enter a value of ‘100’.int
count 

Limits the result set to a defined number of results. Enter 0 (zero) or leave blank not to limit.

int
orderBy Orders the results by field name. You can add multiple sort fields separated by a comma delimiter ','string
direction The sort direction.string
Code Block
titleResponse
[
  {
    "createdUtc": "dateTime",
    "databaseName": "aCountries",
    "lastBuiltUtc": "Datetime",
    "permissionsSummary": int,
    "sizeInMb": float,
    "status": int,
    "title": "string"
  }
]

Properties

PropertyDescription
createdUtcThe server's creation date.
databaseNameThe name of the database.
lastBuiltUtcThe server's last build date.
permissionsSummaryA list of permissions.
sizeInMbThe size of the ElastiCube in MB.
status

The status of the ElastiCube.

 

The status of the ElastiCube:

 

1 - stopped

 

2 - running

 

4 - faulted

 

8 - being deleted

 

16 - currently restarting

 

32 - wrong version

 

64 - the ElastiCube is down because it is 32 bit data on a 64 bit codebase

 

128 - the ElastiCube is down because it is 64 bit data on a 32 bit codebase

 

256 - locked

 

512 - the ElastiCube or its child is currently in a build process.

 

1024 - the ElastiCube is starting, but not yet running.

 

2048 - the ElastiCube is in a build process.

 

4096 - trying to import a BigData ElastiCube on a non-BigData server

 

8192 - trying to import a non-BigData ElastiCube on a BigData server

 

16384 - Building is finished, now post indexing is running

 

32768 - the ElastiCube is being stopped but its executable is still running

 

65536 - this ElastiCube is in the process of cancelling an in-progress build

titleThe name of the ElastiCubes.

Error Status Codes

HTTP Status Code
Reason
403forbidden

...

Status
colourBlue
titleGET

...

Expand
titleReturns ElastiCube metadata by entering the server name/address/IP and database name.

Parameters

Parameter
Value
Description
Data Type
servermandatoryThe ElastiCube's server address (name/address/IP)string
elasticubemandatoryEnter a specific ElastiCube ID to return the results for that ElastiCube only.string
Code Block
titleResponse
 [
  {
    "createdUtc": "dateTime",
    "databaseName": "aCountries",
    "lastBuiltUtc": "Datetime",
    "permissionsSummary": int,
    "sizeInMb": float,
    "status": int,
    "title": "string"
  }
]

Error Status Codes

HTTP Status Code
Reason
403forbidden

...

Status
colourBlue
titleGET

...

Expand
titleReturns the status of each ElastiCube in the selected server.

Parameters

Parameter
Value
Description
Data Type
servermandatoryThe ElastiCube's server addressstring
q Enter a search query to return results containing the querystring
offset Defines how many items to skip before returning the results. For example, to return results from value #101 onward, enter a value of ‘100’.int
count 

Limits the result set to a defined number of results. Enter 0 (zero) or leave blank not to limit.

int
orderBy 

Orders the results by field name. You can add multiple sort fields separated by a comma delimiter ','

string
direction The sort direction.string
Code Block
titleResponse
[
  {
    "status": int,
    "title": "string"
  },
]

Properties

PropertyDescription
status

The status of the ElastiCube:

1 - stopped

2 - running

4 - faulted

8 - being deleted

16 - currently restarting

32 - wrong version

64 - the ElastiCube is down because it is 32 bit data on a 64 bit codebase

128 - the ElastiCube is down because it is 64 bit data on a 32 bit codebase

256 - locked

512 - the ElastiCube or its child is currently in a build process.

1024 - the ElastiCube is starting, but not yet running.

2048 - the ElastiCube is in a build process.

4096 - trying to import a BigData ElastiCube on a non-BigData server

8192 - trying to import a non-BigData ElastiCube on a BigData server

16384 - Building is finished, now post indexing is running

32768 - the ElastiCube is being stopped but its executable is still running

65536 - this ElastiCube is in the process of cancelling an in-progress build

titleThe name of the ElastiCube.

Error Status Codes

HTTP Status Code
Reason
403forbidden

...

Status
colourBlue
titleGET

...

Expand
titleReturns the data security rules set up for the ElastiCube.

Click here to learn more about Sisense data security.

Parameters

Parameter
Value
Description
Data Type
servermandatoryThe ElastiCube's server address.string
elasticubemandatoryThe name of the ElastiCube.

string

table The name of the table in the ElastiCube. 
column

 

The name of the column in the table. 
datatype The type if data, for example, 'string'. 
Code Block
titleResponse
 [
  {
    "_id": "objectId",
    "allMembers": bool,
    "column": "string",
    "cubeId": "objectId",
    "datatype": "text",
    "members": [],
    "server": "LocalHost",
    "shares": [
      {
        "type": "default"
      }
    ],
    "table": "string"
  }
]

Properties

PropertyDescription
_IdInternal reference
allMembersRefers to either all members (true), no members (false) or specified members of the members property.
columnThe column name in the table.
cubeIdThe ElastiCube ID.
datatypeThe data type, for example, 'string'.
membersThe values on which data restrictions have been applied.
serverThe name of the ElastiCube server.
sharesAn array with the properties of type, defining the default group or user, and party (the user or group ID).
tableThe name of the table in the ElastiCube.

Error Status Codes

HTTP Status Code
Reason
400invalid elastiCube identifier
403forbidden

...

Status
colourBlue
titleGET

...

Expand
titleReturns data security for a specific user in a specific ElastiCube.

Parameters

Parameter
Value
Description
Data Type
servermandatoryThe ElastiCube's server addressstring
cubemandatoryThe ElastiCube's namestring
usermandatoryThe user's ID or username.string
Code Block
titleResponse
[
  {
    "_id": "objectId",
    "allMembers": bool,
    "column": "String",
    "cubeId": "objectId",
    "datatype": "int",
    "members": [],
    "server": "string",
    "shares": [
      {
        "type": "default"
      }
    ],
    "table": "string"
  }
]

Properties

PropertyDescription
idThe user's unique ID.
allMembersRefers to either all members (true), no members (false) or specified members of the members property.
columnThe name of the column in the table.
cubeIdThe unique ID of the ElastiCube.
datatypeThe data type, for example, 'string'.
membersThe values on which data restrictions have been applied.
serverThe ElastiCube server address.
sharesAn array with the properties of type, defining the default group or user, and party (the user or group ID).
tableThe table in the ElastiCube.

Error Status Codes

HTTP Status Code
Reason
400invalid elastiCube identifier
403forbidden

...

Status
colourBlue
titleGET

...

Expand
titleReturns ElastiCube data security for a column in a table in the ElastiCube.

Parameters

Parameter
Value
Description
Data Type
servermandatoryThe ElastiCube's server address.string
elasticubemandatoryThe name of the ElastiCubestring
tablemandatoryThe name of the table in the ElastiCubestring
columnmandatoryThe name of the column in the tablestring
Code Block
titleResponse
 

Error Status Codes

HTTP Status Code
Reason
400invalid ElastiCube identifier
403forbidden

...

Status
colourBlue
titleGET

...

Expand
titleReturns all authentication records for the given ElastiCube.

Parameters

Parameter
Value
Description
Data Type
servermandatoryThe ElastiCube's server address.string
elasticubemandatoryThe name or ID of the ElastiCubestring
Code Block
languagejs
titleResponse
{
  "server": "string",
  "title": "string",
  "shares": [
    {
      "permission": "string",
      "partyId": "string",
      "type": "string",
	  "shareId": "objectId",
      "permission": null,
      "rule": "view"
    }
  ]
}

Properties

PropertyDescription
inherited 
serverThe ElastiCube's server address.
titleThe name of the ElastiCube.
shares

An array containing the different permissions. Each permission is an ACL (access control level) object.

partyid - The ID of the party (either a user or user group)

type -  type of party (user or user group)

permission - level of permission (read , write, admin). Only read is currently supported.

Error Status Codes

HTTP Status Code
Reason
400invalid server
400invalid cube ID
403forbidden

...

Actions

...

Expand
titleStarts the ElastiCube Server.

Parameters

Parameter
Value
Description
Data Type
serverMandatoryThe ElastiCube's server address.string
elasticubeMandatoryThe name or ID of the ElastiCube.string

Error Status Codes

HTTP Status Code
Reason
400invalid server
400invalid elasticube
403forbidden

...

Expand
titleStops the ElastiCube Server.

Parameters

Parameter
Value
Description
Data Type
serverMandatoryThe ElastiCube's server address.string
elasticubeMandatoryThe name of the ElastiCube.string

Error Status Codes

HTTP Status Code
Reason
400invalid server
400invalid ElastiCube
403forbidden

...

Expand
titleRestarts the ElastiCube server.

Parameters

Parameter
Value
Description
Data Type
serverMandatory

The server address of the ElastiCube.

string
elasticubeMandatoryelasticube namestring

Error Status Codes

HTTP Status Code
Reason
400invalid server
400invalid elasticube
403forbidden

...

Expand
titleStarts the build process for an ElastiCube.

This operation includes the option to select the type of build.

Parameters

Parameter
Value
Description
Data Type
serverMandatoryThe server address of the ElastiCube.string
elasticubeMandatoryThe name or ID of the ElastiCubestring
type Process Type: None, Full,Delta, Custom, FullUpdateExistingstring

Error Status Codes

HTTP Status Code
Reason
400invalid server
400invalid elasticube
403forbidden

...

Expand
titleStops the build process for an ElastiCube.

Parameters

Parameter
Value
Description
Data Type
serverMandatoryThe server address of the ElastiCube.string
elasticubeMandatoryThe name of the ElastiCube.string

Error Status Codes

HTTP Status Code
Reason
400invalid server
400invalid elasticube
403forbidden

...

Expand
titleExecutes a JAQL query on the ElastiCube.

As an example, the following JAQL query returns total quantity by contact name.

Code Block
titleExample JAQL
{

  "datasource": {

    "title": "Training",

    "id": "aLOCALHOST_aTRAINING",

    "address": "LocalHost",

    "database": "aTraining"

  },

  "metadata": [

    {

      "jaql": {

        "table":
"Customers",

        "column":
"ContactName",

        "dim":
"[Customers.ContactName]",

        "datatype":
"text",

        "title":
"ContactName"

      }
     
    },

    {

      "jaql": {

        "table":
"OrderDetails",

        "column": "Quantity",

        "dim":
"[OrderDetails.Quantity]",

        "datatype":
"numeric",

        "agg": "sum",

        "title": "Total
Quantity"

      }
   
    },
 
  ],

  "count": 20000,

  "offset": 0,

}

 Parameters

ParameterValueDescriptionData Type
JaqlMandatoryThe Jaql query.Jaql
elasticubeMandatoryThe name or ID of the ElastiCube.string

Error Status Codes

HTTP Status CodeReason
400invalid elasticube identifier
403forbidden

...

Expand
titleDefines data security for an ElastiCube.

For more information about Sisense data security, click here.

Parameters

ParameterValueDescriptionData Type
servermandatoryThe server address of the ElastiCube.
string
elasticubemandatoryThe name of the ElastiCube.string
List[elasticubeNewDataSecurityItemCubeGiven]mandatoryThe data security object that needs to be updated.
Code Block
titleModel Schema
[
  {
    "table": "string",
    "column": "string",
    "datatype": "string",
    "shares": [
      {
        "party": "string",
        "type": "string"
      }
    ],
    "members": [
      "string"
    ],
    "allMembers": "bool"
  }
]

Properties

PropertyDescription
Shares

An array containing permissions. Each permission is an ACL, which includes:

  • partyId - The ID of the party (either user or group) that this ACL relates to
  • type - type of party (group or user)
  • permission - level of permission (read , write, admin...). Only read is currently supported.
allMembersRefers to either all members (true), no members (false) or specified members of the members property.
 membersIf 'allMembers' is present (either true or false) this members array is ignored; otherwise- contains the members that this data security record is about.

Error Status Codes

HTTP Status CodeReason
404dataContext not found
403forbidden

...

titleAdds new data security for ElastiCube.

Parameters

...

Code Block
titleModel Schema
[
  {
    "server": "string",
    "elasticube": "string",
    "table": "string",
    "column": "string",
    "datatype": "string",
    "shares": [
      {
        "party": "string",
        "type": "string"
      }
    ],
    "members": [
      "string"
    ],
    "allMembers": "bool"
  }
]

Properties

PropertyDescription
serverThe ElastiCube server address.
elasticubeThe name of the ElastiCube
tableThe name of the table in the ElastiCube.
column

The name of the column in the table.

datatypeThe type if data, for example, 'string'.
shares

An array containing permissions. Each permission is an ACL, which includes:

partyId - The ID of the party (either user or group) that this ACL refers to.
type - type of party (group or user)
allMembers - true indicates "everything". false indicates "nothing"
members - If 'allMembers' is present (either true or false) this members array is ignored, otherwise contains the members that this data security record is about.

Error Status Codes

HTTP Status CodeReason
404dataContext not found
403forbidden

...

titleDefines a new permission for the given ElastiCube.

Parameters

...

The 'shares' is an array containing the different permissions. Each permission is an ACL (access control level).

Code Block
titleModel Schema
[
  {
    "permission": "string",
    "partyId": "string",
    "type": "string"
  }
]

Properties

PropertyDescription
permission 
partyIdThe ID of the party (either user or group) that this ACL relates to.
typeThe type of party (group or user).

Error Status Codes

HTTP Status CodeReason
400invalid server
400invalid cube ID
403forbidden

...

Status
colourYellow
titlePUT

...

titleUpdates the permissions (ACLs) for the current ElastiCube.

Parameters

...

Code Block
titleModel Schema
[
  {
    "permission": "string",
    "partyId": "string",
    "type": "string"
  }
]

Properties

PropertyDescription
permission 
partyIdThe ID of the party (either user or group) that this ACL relates to.
typeThe type of party (group or user).

Error Status Codes

HTTP Status CodeReason
400invalid server
400invalid cube ID
403forbidden

...

Status
colourYellow
titlePUT

...

Expand
titleDefines permissions for an ElastiCube server.

Defines which permissions will be used as the default permissions for ElastiCubes without specified permissions of their own.

Parameters

ParameterValueDescriptionData Type
servermandatoryThe server address of the ElastiCube.string
shares The 'shares' is an array containing the different permissions. Each permission is an ACL (access control level).
Code Block
titleModel Schema
[
  {
    "permission": "string",
    "partyId": "string",
    "type": "string"
  }
]

Properties

PropertyDescription
permission 
partyIdThe ID of the party (either user or group) that this ACL relates to.
typeThe type of party (group or user).

Error Status Codes

HTTP Status Code
Reason
400invalid server
403forbidden

...

Status
colourRed
titleDELETE

...

Expand
titleDeletes data context from a column in an ElastiCube table.

Parameters

Parameter
Value
Description
Data Type
servermandatoryThe server address of the ElastiCube.string
elasticubemandatoryThe name of the ElastiCube.

string

tablemandatoryThe name of the table in the ElastiCube.string
columnmandatoryThe name of the column in the table.string

Error Status Codes

HTTP Status Code
Reason
400invalid datasource identifier
403forbidden

...

Status
colourRed
titleDELETE

...

Expand
titleDeletes all permissions for the ElastiCube.

Deletes all permissions for the ElastiCube, and reverts permissions to the server defaults.

Parameters

Parameter
Value
Description
Data Type
servermandatoryThe server address of the ElastiCube.string
elasticubemandatoryThe name or ID of the ElastiCube.

string

Error Status Codes

HTTP Status Code
Reason
400invalid server
400invalid cube ID
403forbidden

...

Users

...

Metadata

...

Status
colourBlue
titleGET

...

Expand
titleReturns all users and related metadata.

Parameters

ParameterValueDescriptionData Type
limit Limits the result set to a defined number of resultsint
skip Defines how many items to skip before returning the results.int
search Enter a search query to return results matching the query.string
orderby Orders the results by field name. You can add multiple sort fields separated by a comma delimiter ','string
desc Defines the order of the results. True returns results in a descending order.bool
onlyAD Searches only Active Directory users.bool
groupsnames Includes the user's groups if the user belongs to one or more groups.bool
Code Block
languagejs
titleResponse
[
  {
    "_id": "ObjectId",
	"active": bool,
    "userName": "string",
    "roleId": "ObjectId",
    "email": "string",
    "firstName": "string",
	"hash": "string",
    "lastName": "string",
    "active": "bool",
    "created": "dateTime",
    "lastUpdated": "dateTime",
	"preferences": {}
    "lastLogin": "dateTime",
	"userName": "string",
    "roleName": "string",
    "baseRoleName": "string"
  }
]

Error Status Codes

HTTP Status CodeReason
400invalid search
400invalid skip
403forbidden

...

Status
colourBlue
titleGET

...

Expand
titleSearches for users in Active Directory.

Note: This function does not search for users in the Sisense repository.

Parameters

ParameterValueDescriptionData Type
limit Limits the result set to a defined number of results. Enter 0 (zero) or leave blank not to limit.int
checkExist Checks if the user exists in the database.bool
search Enter a search query to return results matching the query.string
Code Block
languagejs
titleResponse
[
  {
    "_id": "ObjectId",
    "userName": "string",
    "roleId": "ObjectId",
    "email": "string",
    "firstName": "string",
    "lastName": "string",
    "active": "bool",
    "created": "dateTime",
    "lastUpdated": "dateTime",
    "lastLogin": "dateTime"
  }
]

Properties

PropertiesDescription
_idThe user's unique ID.
userNameThe user's username.
roleIdInternal reference
emailThe user's email address.
firstNameThe user's first name.
lastNameThe user's last name.
activeStates whether the user is activated.
createdThe date on which the user was created in Sisense.
lastUpdatedThe user's last update.
lastLoginThe last time the user logged in.

Error Status Codes

HTTP Status CodeReason
400invalid search
400invalid skip
403forbidden

...

Status
colourBlue
titleGET

...

Expand
titleSearches for users in all user directories.

This function searches the Sisense repository, and if the user is not found, searches for the user in Active Directory.

Parameters

ParameterValueDescriptionData Type
limit 

Limits the result set to a defined number of results

Enter 0 (zero) or leave blank not to limit.
int
search Enter a search query to return results matching the query.string
Code Block
languagejs
titleResponse
[
  {
    "_id": "ObjectId",
    "userName": "string",
    "roleId": "ObjectId",
    "email": "string",
    "firstName": "string",
    "lastName": "string",
    "active": "bool",
    "created": "dateTime",
    "lastUpdated": "dateTime",
    "lastLogin": "dateTime"
  }
]

Properties

PropertiesDescription
_idThe user's unique ID.
userNameThe user's username.
roleIdInternal reference
emailThe user's email address.
firstNameThe user's first name.
lastNameThe user's last name.
activeStates whether the user is activated.
createdThe date on which the user was created.
lastUpdatedThe user's last update.
lastLoginThe last time the user logged in.

Error Status Codes

HTTP Status CodeReason
400invalid search
400invalid skip
403forbidden

...

Status
colourBlue
titleGET

...

Expand
titleCounts users using a defined query string.

Returns the number of users with the query result in their usernames.

Parameters

Parameter
Value
Description
Data Type
search Searches for users with usernames that include the query string.string
Code Block
titleResponse
{
  "collection": "string",
  "count": int
}

Properties

PropertyDescription
collectionInternal reference
countThe number of users.

Error Status Codes

HTTP Status Code
Reason
400invalid search
400invalid limit
403forbidden

...

Status
colourBlue
titleGET

...

Expand
titleReturns metadata for a user by username or user ID.

Parameters

ParameterValueDescriptionData Type
userMandatoryThe user's ID or usernamestring
Code Block
languagejs
titleResponse
{
  "_id": "ObjectId",
  "userName": "string",
  "roleId": "ObjectId",
  "email": "string",
  "firstName": "string",
  "lastName": "string",
  "active": "bool",
  "created": "dateTime",
  "lastUpdated": "dateTime",
  "lastLogin": "dateTime"
}

Properties

PropertiesDescription
_idThe user's unique ID.
userNameThe user's username.
roleIdInternal reference
emailThe user's email address.
firstNameThe user's first name.
lastNameThe user's last name.
activeStates whether the user is activated.
createdThe date on which the user was created.
lastUpdatedThe user's last update.
lastLoginThe last time the user logged in.
preferencesThe user's locale preferences.

Error Status Codes

HTTP Status CodeReason
400invalid ID
400ID not found
403forbidden

...

Status
colourBlue
titleGET

...

Expand
titleRetrieves my user details.
Code Block
languagejs
titleResponse
{
  "_id": "ObjectId",
  "active": "bool",
  "created": "dateTime",
  "userName": "string",
 "firstName": "string",
 "lastLogin": "dateTime",
 "lastName": "string",
 "lastUpdated": "dateTime",
 "roleId": "ObjectId",
 "preferences": {},
  "email": "string",
  "userAuth": {} 
}

Properties

PropertiesDescription
_idThe user's unique ID.
activeStates whether the user is activated.
createdThe date on which the user was created.
emailThe user's email address.
firstNameThe user's first name.
lastLoginThe last time the user logged in.
lastNameThe user's last name.
lastUpdatedThe user's last update.
userNameThe user's username.
roleIdInternal reference
preferencesIndicates locale preferences.

userAuth

A list of permissions for the user.

Error Status Codes

HTTP Status CodeReason
403forbidden

...

Actions

...

titleReturns the users and related metadata of a simulated operation that adds multiple users.

Note: This operation does not add users.

Parameters

...

Code Block
languagejs
[
  {
    "userName": "string",
    "roleId": "ObjectId",
    "email": "string",
    "firstName": "string",
    "lastName": "string",
    "preferences": {
      "localeId": "string"
    }
  }
]

Properties

PropertyDescription
userNameThe user's username.
roleIdThe user role (admin, designer or viewer)
emailThe user's email address.
firstNameThe user's first name.
lastNameThe user's last name.
preferencesThe user's preferred locale.

...

Error Status Codes

HTTP Status CodeReason
400invalid input
403forbidden

...

Expand
titleAdds a new user.

Parameters

ParameterValueDescriptionData Type
List[user]Mandatory

The user object includes all the user information.

Model Schema

Code Block
languagejs
titleModel Schema
[
  {
    "userName": "string",
    "roleId": "ObjectId",
    "email": "string",
    "firstName": "string",
    "lastName": "string",
    "preferences": {
      "localeId": "string"
    }
  }
]

Properties

PropertyDescription
userNameThe user's username.
roleIdThe user role (admin, designer or viewer).
emailThe user's email address.
firstNameThe user's first name.
lastNameThe user's last name.
preferencesThe user's preferred locale.
notify Send notifications to the user.boolean

Error Status Codes

HTTP Status CodeReason
400invalid input
403forbidden

...

titleImports a user from Active Directory as a new user in Sisense.

Parameters

...

Code Block
languagejs
titleModel Schema
{
  "userName": "string",
  "roleId": "ObjectId",
  "email": "string",
  "firstName": "string",
  "lastName": "string",
  "preferences": {
    "localeId": "string"
  }
}

 Properties

PropertyDescription
userNameThe user's username.
roleIdThe user role (admin, designer or viewer).
emailThe user's email address.
firstNameThe user's first name.
lastNameThe user's last name.
preferencesThe user's preferred locale.

Error Status Codes

HTTP Status CodeReason
400invalid input
403forbidden

...

titleSends a user an email to activate or reset the user's password.

Parameters

...

Model Schema

Code Block
languagejs
{
  "email": "string"
}

 Properties

PropertyDescription
emailThe user's email.

Error Status Codes

HTTP Status CodeReason
403forbidden

...

titleActivates a user by user ID or username.

Parameters

...

String

...

Code Block
languagejs
titleModel Schema
{
  "password": "string",
  "preferences": {
    "localeId": "string"
  }
}

Properties

PropertyDescription
passwordThe user's password.
preferencesThe user's preferred locale.

Error Status Codes

HTTP Status CodeReason
400invalid input
403forbidden

...

Expand
titleRecovers a user's password by user ID or username.

Parameters

ParameterValueDescriptionData Type
userMandatory
User's ID or username

String

src The URL of the page to redirect the user after activation.string
userActivateMandatoryThe user object that needs to be updated.
Code Block
languagejs
titleModel Schema
{
  "password": "string",
  "preferences": {
    "localeId": "string"
  }
}

Properties

PropertyDescription
passwordThe user's password.
preferencesThe user's preferred locale preference.

Error Status Codes

HTTP Status CodeReason
400invalid ID
403forbidden
404ID not found

...

Expand
titleDeletes the user by ID.

Parameters

Parameter
Value
Description
Data Type
list[string]Mandatory
The user object that needs to be updated.

list[string]

Error Status Codes

HTTP Status Code
Reason
400invalid ID
404ID not found
403forbidden

...

Expand
titleValidates existing users by entering their emails.

Parameters

Parameter
Value
Description
Data Type
list[string]Mandatory
List of emails of users that require validation.

list[string]

Error Status Codes

HTTP Status Code
Reason
400invalid input
403forbidden

...

Status
colourYellow
titlePUT

...

Expand
titleUpdates one or more user details, by user ID or username.

Parameters

ParameterValueDescriptionData Type
userMandatoryThe user's ID or username.string
userUpdateMandatoryThe user object that needs to be updated.
Code Block
languagejs
titleModel Schema
{
  "userName": "string",
  "roleId": "ObjectId",
  "email": "string",
  "firstName": "string",
  "lastName": "string",
  "preferences": {
    "localeId": "string"
  }
}

Properties

PropertyDescription
userNameThe user's username.
roleIdThe user role (admin, designer or viewer).
emailThe user's email address.
firstNameThe user's first name.
lastNameThe user's last name.
preferencesThe user's preferred locale.

Error Status Codes

HTTP Status CodeReason
400invalid ID
404ID not found
403forbidden

...

Status
colourRed
titleDELETE

...

Expand
titleDeletes a user by user ID or username.

Parameters

Parameter
Value
Description
Data Type
userMandatoryThe user's ID or username.string

Error Status Codes

HTTP Status Code
Reason
400invalid ID
404ID not found
403forbidden

...

Groups

...

Metadata

...

Status
colourBlue
titleGET

...

Expand
titleReturns all user groups with metadata.

Parameters

ParameterValueDescriptionData Type
limit 

Limits the result set to a defined number of results. Enter 0 (zero) or leave blank not to limit.

int
skip Defines how many items to skip before returning the results. int
search Enter a search query to return results matching the query.string
dn Search for a group using an Active Directory dn as the search query. Use the semi-colon ; delimiter to search multiple groups.string
orderBy Orders the results by field name. You can add multiple sort fields separated by a comma delimiter ',' string
desc Defines the order of the results. True returns results in a descending order.boolean
onlyAD Searches only Active Directory user groups.boolean
noAD Search only for non Active Directory groups.boolean
exactMatch Searches exact matches when searching by the Active Directory dn.boolean
usersCount Counts the number of users in each group.boolean
Code Block
languagejs
titleResponse
[
  {
    "_id": "ObjectId",
    "name": "string",
    "roleId": "ObjectId",
    "created": "dateTime",
    "lastUpdated": "dateTime"
  }
]

Properties

PropertiesDescription
roleIdRelevant only for Active Directory groups.
_idThe user group's unique ID.
nameThe user group's name.
adStates whether the group is an Active Directory group.
createdThe date and time when the group was created.
lastUpdatedThe date and time when the group was last updated.

Error Status Codes

HTTP Status CodeReason
400Invalid source
400invalid skip
403forbidden

...

Status
colourBlue
titleGET

...

Expand
titleSearches for groups directly in Active Directory.

Note: This operation does not search for groups created directly in Sisense.

Parameters

ParameterValueDescriptionData Type
limit 

Limits the result set to a defined number of results. Enter 0 (zero) or leave blank not to limit.

int
checkExist Check if a group exists in Active Directory, and if not, searches groups created in Sisense. boolean
search Enter a search query to return results matching the query. 
Code Block
languagejs
titleResponse
[
  {
    "_id": "ObjectId",
    "name": "string",
    "roleId": "ObjectId",
    "created": "dateTime",
    "lastUpdated": "dateTime"
  }
]

Properties

PropertyDescription
name The user group's name.
created The date and time when the group was created.
lastUpdated The date and time when the group was last updated.

Error Status Codes

HTTP Status CodeReason
400Invalid search
400invalid skip
403forbidden

...

Status
colourBlue
titleGET

...

Expand
titleSearches for groups in all directories.

This function searches groups created in Sisense, and if not found, will search in Active Directory groups.

Parameters

ParameterValueDescriptionData Type
limit 

Limits the result set to a defined number of results. Enter 0 (zero) or leave blank not to limit.

int
search Enter a search query to return results matching the query.string
usersCount Returns the number of users per group.boolean
Code Block
languagejs
titleResponse
[
  {
    "_id": "ObjectId",
    "name": "string",
    "roleId": "ObjectId",
    "created": "dateTime",
    "lastUpdated": "dateTime"
  }
]

Properties

PropertyDescription
roleIdRelevant for Active Directory groups only.
nameThe user group's name.
adStates whether the group is Active Directory
createdThe date and time when the group was created.
lastUpdatedThe date and time when the group was last updated.
_idThe user group's unique ID.

Error Status Codes

HTTP Status CodeReason
400Invalid search
403forbidden

...

Status
colourBlue
titleGET

...

Expand
titleReturns metadata for a group by group ID or name.

Metadata includes name, role ID, created date and time, and last update date and time.

Parameters

ParameterValueDescriptionData Type
groupMandatoryThe ID or username of the groupstring
Code Block
languagejs
titleResponse
{
  "_id": "ObjectId",
  "name": "string",
  "roleId": "ObjectId",
  "created": "dateTime",
  "lastUpdated": "dateTime"
}

Properties

PropertyDescription
roleId Relevant for Active Directory groups only.
name The user group's name.
adStates whether the group is Active Directory
created The date and time when the group was created.
lastUpdated The date and time when the group was last updated.
_id The user group's unique ID.

Error Status Codes

HTTP Status CodeReason
400Invalid ID
404ID not found
403forbidden

...

Status
colourBlue
titleGET

...

Expand
titleReturns a list of users in a group together with each user's metadata.

Metadata includes the user's username, role ID, email, first and last names, active state, created date, last login, and last update date.

Parameters

ParameterValueDescriptionData Type
groupMandatoryThe group's ID or username.string
Code Block
languagejs
titleResponse
[
  {
    "_id": "ObjectId",
    "userName": "string",
    "roleId": "ObjectId",
    "email": "string",
    "firstName": "string",
    "lastName": "string",
    "active": "bool",
    "created": "dateTime",
    "lastUpdated": "dateTime",
    "lastLogin": "dateTime"
  }
]

Properties

PropertyDescription
_idThe user's unique ID.
activeStates whether the user is activated.
createdThe date and time when the user was created.
emailThe user's email.
firstNameThe user's first name.
lastLoginThe date and time of the user's last login.
lastNameThe user's last name.
lastUpdatedThe date and time when the user was last updated.
preferencesThe user's defined locale.
roleIdThe user role (admin, designer or viewer).
userNameThe user's username.
roleNamethe name of the user's role.

Error Status Codes

HTTP Status CodeReason
400Invalid ID
404ID not found
403forbidden

...

Actions

...

Expand
titleReturns a list of groups by user IDs.

Parameters

ParameterValueDescriptionData Type
List[ObjectId]MandatoryList of user IDsstring
usersCount Returns the number of users per group.Boolean
Code Block
languagejs
titleResponse
[
  {
    "_id": "ObjectId",
    "name": "string",
    "roleId": "ObjectId",
    "created": "dateTime",
    "lastUpdated": "dateTime"
  }
]

Properties

PropertyDescription

_id

The user's unique ID.
nameThe group names.
roleIdThe user role (admin, designer or viewer).
createdThe date and time when the user was created.
lastUpdatedhe date and time when the user was last updated.

Error Status Codes

HTTP Status CodeReason
400Invalid ID
404ID not found
403forbidden

...

Expand
titleAdds a new Sisense user group.

Parameters

ParameterValueDescriptionData Type
List[group]MandatoryThe group object that needs to be added.
Code Block
languagejs
titleModel Schema
[
  {
    "_id": "ObjectId",
    "name": "string",
    "roleId": "ObjectId",
    "created": "dateTime",
    "lastUpdated": "dateTime"
  }
]
Code Block
languagejs
titleResponse
{
  "_id": "ObjectId",
  "name": "string",
  "roleId": "ObjectId",
  "created": "dateTime",
  "lastUpdated": "dateTime"
}

Error Status Codes

HTTP Status CodeReason
400Invalid input
403forbidden

...

Expand
titleAdds a new Active Directory user group.

Note: If you add an objectSid key, then the data will not be imported again from Active Directory. It is recommended to use the Active Directory cn (common name) or name, but not both. The cn is preferred.

Parameters

ParameterValueDescriptionData Type
List[ADgroup]MandatoryThe group object that needs to be added to the collection.
Code Block
languagejs
titleModel Schema
[
  {
    "_id": "ObjectId",
    "objectSid": "array/buffer",
    "cn/name": "string",
    "dn": "string",
    "uSNChanged": "string",
    "mail": "string",
    "roleId": "ObjectId",
    "created": "dateTime",
    "lastUpdated": "dateTime"
  }
]
Code Block
languagejs
titleResponse
[
  [
    {
      "name": "testgroupapi",
      "ad": false,
      "objectSid": "",
      "dn": "",
      "uSNChanged": "",
      "mail": "",
      "created": "2015-06-17T12:26:08.772Z",
      "lastUpdated": "2015-06-17T12:26:08.772Z",
      "_id": "55816760d68d4a302b000001"
    }
  ]
]

Properties

PropertyDescription
nameThe name of the new group.
adThe Active Directory.

objectSid

 The Active Directory objectSid.
dnThe break down of your domain including all hosts. 

created

The date and time the group was created.
lastUpdated The date and time the group was last updated.

Error Status Codes

HTTP Status CodeReason
400Invalid input
403forbidden

...

Expand
titleAdds users to a Sisense user group.

Parameters

Parameter
Value
Description
Data Type
groupMandatoryThe group's ID or name.string
List[ADgroup]MandatoryThe IDs or usernames of the users that need to be added to the group.

List[string]

Error Status Codes

HTTP Status Code
Reason
400Invalid input
403forbidden

...

titleChecks if the group exists.

Parameters

...

Code Block
languagejs
titleModel Schema
{
  "name": "string"
}

Properties

PropertyDescription
nameThe name of the user group.

Error Status Codes

HTTP Status CodeReason
400Invalid ID
404ID not found
403forbidden

...

Status
colourYellow
titlePUT

...

Expand
titleUpdates a group by group ID or name. What are we updating? name, role (only for AD)

Parameters

ParameterValueDescriptionData Type
groupMandatoryThe group's ID or name.

string

Error Status Codes

HTTP Status CodeReason
400Invalid ID
404ID not found
403forbidden

...

Status
colourRed
titleDELETE

...

Expand
titleDeletes multiple groups by group name or ID.

Parameters

Parameter
Value
Description
Data Type
deleteGroupMandatory

The IDs of the groups to delete.

{
  "groups": [
    string
  ],
  "deleteAdUsers""boolean"
}

Properties

PropertyDescription
groups

The groups to delete.

deleteAdUsersEnter true to delete the users of the group in addition to the group.

Error Status Codes

HTTP Status Code
Reason
400Invalid ID
404ID not found
403forbidden

...

Status
colourRed
titleDELETE

...

Expand
titleDeletes a group by group ID or name.

Parameters

Parameter
Value
Description
Data Type
groupMandatoryThe group's ID or name.

string

deleteauthors Select true if you want to delete the users of the Active Directory group.boolean

Error Status Codes

HTTP Status Code
Reason
400Invalid ID
404ID not found
403forbidden

...

Status
colourRed
titleDELETE

...

Expand
titleRemoves users from a user group.

Parameters

Parameter
Value
Description
Data Type
groupMandatoryThe group's ID or name.

string

List[string]MandatoryThe user IDs or usernames to remove from the group.List[string]

Error Status Codes

HTTP Status Code
Reason
400Invalid input
403forbidden

...

Authorization

...

Status
colourBlue
titleGET

...

Expand
titleForces the user to be logged out.

Error Status Codes

HTTP Status Code
Reason
400Invalid ID
403forbidden

...

Status
colourBlue
titleGET

...

Expand
titleReturns users that are logged in.
Code Block
titleResponse
 {
  "isAuthenticated": bool
}

Properties

PropertyDescription

isAuthenticated

Indicates whether the user is logged in or not.

...

Branding

...

Metadata

...

Status
colourBlue
titleGET

...

Expand
titleReturns the current branding metadata.
Code Block
languagejs
titleResponse
[
  {
    "logo": {
      "desktop": {
        "small": "path string",
        "large": "path string"
      },
      "tablet": {
        "small": "path string",
        "large": "path string"
      },
      "phone": {
        "small": "path string",
        "large": "path string"
      }
    },
    "favicon": "string",
    "pageTitle": "string",
    "loginTitle": "string",
    "loginSubtitle": "string",
    "activationTitle": "string",
    "activationSubtitle": "string",
    "contactUsText": "string",
    "copyrightText": "string",
    "homePage": "string",
    "emails": {
      "senderEmail": "string",
      "senderName": "string",
      "templates_directory": "string",
      "passwordRecoverySubject": "string",
      "newUserInviteSubject": "string",
      "shareWithNewUserSubject": "string",
      "shareWithExistingUser": "string"
    }
  }
]

Properties

PropertyDescription

logo

The paths to different logos suited for different device types.

favicon

The path to an image to replace the default Sisense logo.

pageTitle

Text to replace the default 'Sisense' title.

loginTitle

Text to replace "WELCOME TO SISENSE".

loginSubtitle

Text to replace "Sign in & start exploring".

activationTitle

Text to replace "Welcome".

activationSubtitle

Text to replace "Welcome".

contactUsText

Text to replace the default Sisense contact details.

copyrightText

Text to replace Sisense’s copyright text.

homePage

A URL that replaces the default "http://www.sisense.com".

emails

An array that includes all email branding.

"senderEmail":"[email protected]",

"senderName":"sys-admin",

"templates_directory" : "/resources/branding/emails",

"passwordRecoverySubject" : "Sisense password recovery",

"newUserInviteSubject" : "Sisense account activation",

"shareWithNewUserSubject" : "A Dashboard has been shared with you:",

"shareWithExistingUserSubject" : "A Dashboard has been shared with you:"

Error Status Codes

HTTP Status CodeReason
400Invalid ID
404ID not found
403forbidden

...

Actions

...

titleAdds new branding to your Sisense dashboards.

Branding includes customized texts, logos and emails.

Parameters

...

The branding object that needs to be added to the collection.

Code Block
languagejs
titleModel Schema
{
  "logo": {
    "desktop": {
      "small": "path string",
      "large": "path string"
    },
    "tablet": {
      "small": "path string",
      "large": "path string"
    },
    "phone": {
      "small": "path string",
      "large": "path string"
    }
  },
  "favicon": "string",
  "pageTitle": "string",
  "loginTitle": "string",
  "loginSubtitle": "string",
  "activationTitle": "string",
  "activationSubtitle": "string",
  "contactUsText": "string",
  "copyrightText": "string",
  "homePage": "string",
  "emails": {
    "senderEmail": "string",
    "senderName": "string",
    "templates_directory": "string",
    "passwordRecoverySubject": "string",
    "newUserInviteSubject": "string",
    "shareWithNewUserSubject": "string",
    "shareWithExistingUser": "string"
  }
}

Properties

...

loginTitle

...

Text to replace "WELCOME TO SISENSE".

...

loginSubtitle

...

Text to replace "Sign in & start exploring".

...

activationTitle

...

Text to replace "Welcome".

...

activationSubtitle

...

Text to replace "Welcome".

...

contactUsText

...

Text to replace the default Sisense contact details.

...

copyrightText

...

Text to replace Sisense’s copyright text.

...

homePage

...

A URL that replaces the default "http://www.sisense.com".

...

An array that includes all email branding.

 

...

"senderEmail":"[email protected]company.com",

"senderName":"sys-admin",

"templates_directory" : "/resources/branding/emails",

"passwordRecoverySubject" : "Sisense password recovery",

"newUserInviteSubject" : "Sisense account activation",

"shareWithNewUserSubject" : "A Dashboard has been shared with you:",

"shareWithExistingUserSubject" : "A Dashboard has been shared with you:"

 

Code Block
languagejs
titleResponse
[
  {
    "logo": {
      "desktop": {
        "small": "path string",
        "large": "path string"
      },
      "tablet": {
        "small": "path string",
        "large": "path string"
      },
      "phone": {
        "small": "path string",
        "large": "path string"
      }
    },
    "favicon": "string",
    "pageTitle": "string",
    "loginTitle": "string",
    "loginSubtitle": "string",
    "activationTitle": "string",
    "activationSubtitle": "string",
    "contactUsText": "string",
    "copyrightText": "string",
    "homePage": "string",
    "emails": {
      "senderEmail": "string",
      "senderName": "string",
      "templates_directory": "string",
      "passwordRecoverySubject": "string",
      "newUserInviteSubject": "string",
      "shareWithNewUserSubject": "string",
      "shareWithExistingUser": "string"
    }
  }
]

Error Status Codes

HTTP Status CodeReason
400Invalid input
403forbidden

...

Status
colourRed
titleDELETE

...

Expand
titleResets the current branding to the default Sisense branding.

Error Status Codes

HTTP Status CodeReason
400Invalid input
404ID not found
403forbidden

...

Settings

...

Status
colourBlue
titleGET

...

Expand
titleReturns system configuration settings.
Code Block
languagejs
titleResponse
{
  "_id": "ObjectId",
  "alias": "string",
  "email": {
    "enabled": "bool",
    "senderEmail": "string",
    "senderName": "string"
  }
}

Properties

PropertyDescription
_idInternal reference
aliasThe alias (as in domain name).
webserver Indicates whether SSL is enabled, and the cors origin prefrences.
email

enabled - Indicates whether emails are enabled in the server.

senderEmail - The administrator's email address.

senderName - The administrator's name.

Error Status Codes

HTTP Status CodeReason
404name not found
403fobidden

...

titleAdds or updates system settings.

Parameters

...

Code Block
languagejs
titleModel Schema
{
  "alias": "string",
  "email": {
    "enabled": "bool",
    "senderEmail": "string",
    "senderName": "string"
  },
  "webServer": {
    "enableSSl": "bool",
    "cors": {
      "enabled": "bool",
      "allowedOrigins": [
        "string"
      ]
    }
  }
}

Properties

PropertyDescription
aliasThe server alias (as in the domain name).
email

 

enabled - Indicates whether emails are enabled in the server.

senderEmail - The administrator's email address.

senderName - The administrator's name.

webSeverReturns web server details.

Error Status Codes

HTTP Status CodeReason
400invalid input
403forbidden

...

Status
colourBlue
titleGET

...

Expand
titleReturns proxy server settings in your server.

This is to allow geo data (used in area and scatter map widgets) to be pulled in from external Sisense servers.

Parameters

Code Block
titleResponse
{
  "enabled": "bool",
  "ip": "string",
  "port": "int",
  "username": "string",
  "password": "string"
}

Properties

PropertyDescription
enabledIndicates whether proxy settings are enabled.
ipThe IP address of the proxy.
portThe port number of the proxy.
username

The username of the proxy.

passwordThe password required for the proxy.

...

Expand
titleAdds proxy server settings to your server.

This option can be used to allow geo data (used in area and scatter map widgets), to be pulled in from external Sisense servers when such data is blocked by your organization’s proxy server.

Parameters

ParameterValueDescriptionData Type
proxyConfigMandatory

Add the following parameters:

enabled - true or false

ip - Sisense server address

port - Sisense server port

username and password - only if your proxy server requires

Code Block
languagejs
titleModel Schema
{
  "enabled": "bool",
  "ip": "string",
  "port": "int",
  "username": "string",
  "password": "string"
}

Properties

PropertyDescription
enabledIndicates whether proxy settings are enabled.
ipThe IP address of the proxy.
portThe port number of the proxy.
username

The username of the proxy.

passwordThe password of the proxy.

Error Status Codes

HTTP Status CodeReason
403forbidden
400invalid proxy

...

Status
colourYellow
titlePUT

...

titleUpdates proxy server settings in your server.

This option can be used to allow geo data (used in area and scatter map widgets), to be pulled in from external Sisense servers when such data is blocked by your organization’s proxy server.

Parameters

...

Update only the relevant settings:

enabled - true or false

ip - Sisense server address

port - Sisense server port

username and password - only if your proxy server requires

Code Block
languagejs
titleModel Schema
{
  "enabled": "bool",
  "ip": "string",
  "port": "int",
  "username": "string",
  "password": "string"
}

Properties

PropertyDescription
enabledIndicates whether proxy settings are enabled.
ipThe IP address of the proxy.
portThe port number of the proxy.
username

The username of the proxy.

passwordThe password of the proxy.

Error Status Codes

HTTP Status CodeReason
403forbidden
400invalid proxy

...

Status
colourRed
titleDELETE

...

Expand
titleDeletes proxy server settings in your server.

 

...

Status
colourBlue
titleGET

...

Expand
titleReturns security settings, including the API token.
Code Block
titleResponse
{
  "_id": "objectId",
  "name": "string",
  "allowAddServers": bool
}

Properties

PropertyDescription
nameThe name of the security configuration settings.
allowAddServers 

Error Status Codes

HTTP Status Code
Reason
404name not found
403forbidden

...

Expand
titleAdds/updates security settings.

Parameters

ParameterValueDescriptionData Type
securityConfigMandatorySecurity configuration
Code Block
languagejs
titleModel Schema
{
  "_id": "ObjectId",
  "cookieExp": "int",
  "passwordRegex": "string"
}

Properties

PropertyDescription
cookieExpThe cookie expiration in days for the user's login.
passwordRegexThe password regulations.

Error Status Codes

HTTP Status CodeReason
400invalid input
403forbidden

...

Status
colourBlue
titleGET

...

Expand
titleReturns locale settings, including the set locale, and whether autodetect is enabled.
Code Block
titleResponse
{
  "_id": "objectId",
  "name": "string",
  "localization": {
    "default": "string",
    "autoDetectEnabled": bool
  }
}

Properties

PropertyDescription
_idInternal reference
nameThe name of the globalization settings.
localization

default - the locale, for example en-US

autoDetectEnabled - If true, then the locale will inherit the user's set locale from the browser/operating system.

...

titleAdds/updates globalization settings.

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

Parameters

...

Code Block
languagejs
titleModel Schema
{
  "localization": {
    "default": "string",
    "autoDetectEnabled": "bool"
  }
}

Properties

PropertyDescription

default

The default locale for all users.
autoDetectEnabledIf true, then the locale will inherit the user's set locale from the browser/operating system.

Error Status Codes

HTTP Status CodeReason
403forbidden

...

Reporting

...

Expand
titleShares (sends) a dashboard to specified recipients.

Parameters

ParameterValueDescriptionData Type
sendReportsMandatoryreporting object describing the report you want
Code Block
languagejs
titleModel Schema
{
  "assetId": "string",
  "assetType": "string",
  "recipients": [
    {
      "type": "string",
      "recipient": "string"
    }
  ]
}

Properties

PropertyDescription
assetIdThe dashboard ID.
assetTypeCurrently only 'Dashboard'.
recipients

The user ID or username or group ID or group name.

Error Status Codes

HTTP Status CodeReason
400invalid input
403forbidden

...

Roles

...

Status
colourBlue
titleGET

...

Expand
titleReturns all the role types and the enabled permissions per role type.

Parameters

ParameterValueDescriptionData Type
includeManifest Includes the role's manifest (list of permissions showing what's enabled/disabled).boolean
includeBaseRolesName Includes the role's base role name.boolean
compiledRoles Select True.boolean
envelop If true, the response will always be '200' with fail and success codes presented in an array.boolean
Code Block
languagejs
titleResponse
[
  {
    "name": "string",
    "parent": "roleIdOrName",
    "desc": "string",
    "manifest": "{}"
  }
]

Properties

PropertyDescription
nameThe name of the role.
parentThe parent role.
descA description of the role.
manifestThe list of permissions and their status (enabled or disabled for role).
compiledRole True returns full list of role permissions. False returns the compiled base role name.

Error Status Codes

HTTP Status CodeReason
403forbidden

...

Status
colourBlue
titleGET

...

Expand
titleReturns the user role by role ID or role name.

Parameters

ParameterValueDescriptionData Type
idOrNameMandatoryThe name or ID of the rolestring
compiledRole True returns full list of role permissions. False returns the compiled base role name.boolean
Code Block
languagejs
titleResponse
{
  "name": "string",
  "parent": "roleIdOrName",
  "desc": "string",
  "manifest": "{}"
}

Properties

PropertyDescription
nameThe name of the role.
baseRoleNameThe parent role.
manifestThe list of permissions and their status (enabled or disabled for role).

Error Status Codes

HTTP Status CodeReason
400invalid idOrName
404idOrName not found
403forbidden

...

Expand
titleAdds a new role (currently not supported).

 

...

Status
colourRed
titleDELETE

...

Expand
titleDeletes a user role by ID or name.

Note: You cannot delete a base/parent role, and you cannot delete a role still assigned to a user.

Parameters

Parameter
Value
Description
Data Type
idOrNameMandatoryThe ID or name of the role that you want to delete.

string

 Error Status Codes

HTTP Status Code
Reason
400invalid idOrName
404idOrName not found
403forbidden

...

Status
colourYellow
titlePUT

...

Expand
titleUpdates a user role by role ID or name.

Parameters

ParameterValueDescriptionData Type
idOrNameMandatoryThe ID or name of the role.

string

roleMandatory

The updated role object should include the path to the setting you want to change and the setting. Click here to see the correct paths for different settings in the manifest.

Example:

Image Removed

Code Block
languagejs
titleModel Schema
{
  "name": "string",
  "parent": "roleIdOrName",
  "desc": "string",
  "manifest": "{}"
}

Properties

PropertyDescription
nameThe name of the role.
parentThe parent role.
descThe sort order.
manifestAn array with the permissions of the role.

Error Status Codes

HTTP Status CodeReason
400invalid idOrName
404idOrName not found
403forbidden

...

Status
colourBlue
titleGET

...

Expand
titleReturns the permissions of a user role under a specific path in the role manifest.
Parameter
Value
Description
Data Type
idOrNameMandatoryThe role ID or name.

string

pathMandatory

The manifest path. Click here to see paths for the different settings.

For example, /dashboards/filters will return all permissions under filters.

string
compiledRole True returns full list of role permissions. False returns the compiled base role name.boolean

Error Status Codes

HTTP Status Code
Reason
400invalid ID or name
404ID or name not found
403forbidden

...

Status
colourRed
titleDELETE

...

Expand
titleRestores some or all permissions under a specific path in the role manifest.

You can restore a specific permission or all permissions depending on the path.

Parameter
Value
Description
Data Type
idOrNameMandatoryThe role ID or name

string

pathMandatoryThe path to the manifest. Enter the full path of the setting you want to change, as it appears in the hierarchy. Example: dashboard/filters/modify_type. See the reference table for more settings. Enter just a slash to restore all settings.string

Error Status Codes

HTTP Status Code
Reason
400invalid idOrName
404idOrName not found
403forbidden

...

Status
colourYellow
titlePUT

...

Expand
titleUpdates permissions in a user role manifest by role ID or name.
Parameter
Value
Description
Data Type
idOrNameMandatoryThe role ID or name.

string

pathMandatoryThe path to the manifest. Enter the path to the setting that you want to change as it appears in the hierarchy. Do not include the setting in the path. Example: To change the ‘Create’ setting for dashboard filters, enter dashboard/filters/. For creating dashboards, enter /dashboards. See the reference table above for more settings. For a complete list of settings and their relative path, click here.string
manifestMandatoryDefines whether to enable or disable the setting. For example, to enable ‘create’, type in: {create: true}.manifest

Error Status Codes

HTTP Status Code
Reason
400invalid idOrName
404idOrName not found
403forbidden

...

Expand
titleUpdates a user role manifest by role ID or name.

New manifest keys will be added, overriding the existing keys (permissions). If you update only some keys, the other keys will be reset to their default settings.

Parameters

Parameter
Value
Description
Data Type
idOrNameMandatoryThe role ID or name

string

pathMandatoryThe path to the manifest. Enter the path to the setting that you want to change as it appears in the hierarchy. Do not include the setting in the path. Example: To change the ‘Create’ setting for dashboard filters, enter dashboard/filters/. For creating dashboards, enter /dashboards. See the reference table above for more settings.string
manifestMandatoryThe updated manifest object. Defines whether to enable or disable the setting. For example, to enable ‘create’, type in: {create: true}manifest

Error Status Codes

HTTP Status Code
Reason
400invalid idOrName
404idOrName not found
403forbidden

...

Palettes

...

Metadata

...

Status
colourBlue
titleGET

...

Expand
titleReturns a list of available palettes in the Sisense web app.
Code Block
titleResponse
[
  {
    "_id": "objectId",
    "colors": [],
    "name": "string",
    "isDefault": bool,
    "sortOrder": int,
    "isSystem": bool
  },
 ]

Properties

PropertyDescription
_idThe unique Id of the palette
colorsA list of colors used in the palette.
nameThe name of the palette.
isDefaultIndicates whether the palette is the default palette.
sortOrderThe position of the palette in the palettes menu.
isSystemStates whether the palette is one of the pre-installed Sisense palettes.

Error Status Codes 

HTTP Status Code
Reason
403forbidden

...

Status
colourBlue
titleGET

...

Expand
titleReturns the default color palette.
Code Block
titleResponse
{
  "_id": "objectId",
  "colors": [],
  "name": "string",
  "isDefault": bool,
  "sortOrder": int,
  "isSystem": bool,
  "systemDefault": bool
}

Properties

PropertyDescription
_idThe unique Id of the palette
colorsA list of colors used in the palette.
nameThe name of the palette.
isDefaultIndicates whether the palette is the default palette.
sortOrderThe position of the palette in the palettes menu.
isSystemStates whether the palette is one of the pre-installed Sisense palettes.
systemDefaultSpecifies whether this is the default palette if no other palette was specified as default.

...

Actions

...

Expand
titleAdds a new color palette.

The new palette will include colors, and its sort order in the palette drop-down list in the Sisense web app. You can also define whether the new palette will be the default palette.

Parameters

ParameterValueDescriptionData Type
paletteMandatory The new palette to add, and it's colors, sort order, and default option.
Code Block
languagejs
titleModel Schema
{
  "colors": [
    "string"
  ],
  "min": "string",
  "max": "string",
  "name": "string",
  "isDefault": "bool",
  "sortOrder": "number"
}

Properties

PropertyDescription
colors

An array that includes the colors (hexadecimal) in the palette.

Example:

"colors": [
"#779fa8",
"#bf1e1d",
"#787070"
],

minDefines the first color when a color range is used in the widget. The color value is a hexadecimal value.
max Defines the last color when a color range is used in the widget. The color value is a hexadecimal value.
isDefaultSelect true to make this the default palette.
sortOrderThe position of the palette in the palettes menu.

Error Status Codes

HTTP Status CodeReason
403forbidden

...

Status
colourYellow
titlePUT

...

Expand
titleUpdates the dashboard's color palette.

Parameters

ParameterValueDescriptionData Type
nameMandatory Palette's namestring
paletteMandatory The updated palette settings to add
Code Block
languagejs
titleModel Schema
{
  "colors": [
    "string"
  ],
  "min": "string",
  "max": "string",
  "name": "string",
  "isDefault": "bool",
  "sortOrder": "number"
}

Properties

PropertyDescription
colors

The array that includes the colors (hexadecimal) in the palette.

Example:

"colors": [
"#779fa8",
"#bf1e1d",
"#787070"
],

minDefines the first color when a color range is used in the widget. The color value is a hexadecimal value.
maxDefines the last color when a color range is used in the widget. The color value is a hexadecimal value.
nameThe name of the palette
sort OrderThe palette's placement in the drop-down list of palettes.

Error Status Codes

HTTP Status CodeReason
403forbidden

...

Status
colourRed
titleDELETE

...

Expand
titleDeletes a color palette from the color palettes.

Parameters

Parameter
Value
Description
Data Type
nameMandatory Palette's namestring

Error Status Codes

HTTP Status Code
Reason
403forbidden
Info
titleAPI Versioning

Starting from Sisense 6.0, the REST API supports versioning, with the existing endpoints classified as API v0.9 and the new endpoints classified as API v1.0.

(warning) These changes will not break existing scripts & applications using the API.

API Versions

API v0.9

Includes all the endpoints you're familiar with from versions prior to Sisense 6.

These endpoints remain functional in version 6, so your scripts and apps using the API won't break.

For the API v0.9 reference, CLICK HERE

API v1.0

Includes new and improved endpoints introduced in Sisense 6 onward.

Please note that the base URL for these endpoints is different: /api/v1

For the API v1.0 reference, CLICK HERE