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

REST API v0.9 operations are available for the following categories:

ElastiCubes

Metadata

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

Properties

PropertyDescription
titleThe name of the ElastiCube.
fullname

The address together with the title in the format, address/title.

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

Error Status Codes

HTTP Status CodeReason
403Forbidden
/elasticubes/metadata/{elasticube}

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

Parameters

Parameter
Mandatory
Description
Data Type
elasticubeYesThe ElastiCube's name as displayed in the ElastiCube Manager.string
 {
  "title": "string",
  "fullname": "string",
  "id": "objectId",
  "address": "string",
  "database": "string"
}

Properties

Property
Description
titleThe name of the ElastiCube.
fullnameThe address together with the title in the format, address/title.
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

/elasticubes/metadata/{elasticube}/fields

Returns field details including the related column and table.

Parameters

Parameter
Mandatory
Description
Data Type
elasticubeYesThe name of the ElastiCube as dsiplayed in the ElastiCube Manager.String
qNoEnter a specific query to return only fields that include the query string.String
offsetNoDefines how many items to skip before returning the results. For example, to return results from value #101 onward, enter a value of ‘100’.Integer
countNo

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

Integer
[
  {
    "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.
mergedIndicates if merged with another table.
indexedIndicates if the field data was indexed for quicker processing in subsequent builds.

Error Status Codes

HTTP Status Code
Reason
400Invalid ElastiCube identifier
403Forbidden

/elasticubes/{elasticube}/Sql

Parameters

Parameter
Mandatory
Description
Data Type
elasticubeYesThe name of the ElastiCube.String
offsetNo

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

Integer
countNo

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

Integer
formatNoThe format in which the results are returned. String
queryNoThe SQL statement to execute.String


Error Status Codes

HTTP Status Code
Reason
400Invalid Elasticube identifier
403Forbidden
/elasticubes/

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’.Integer
count

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

Integer
direction
The sort direction of the results.String
withPermissions
Include ElastiCube permissions.Bool
[
  {
    "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

514 - 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 in the ElastiCube Manager.

Error Status Codes

HTTP Status Code
Reason
403Forbidden
/elasticubes/servers

Parameters

Parameter
Description
Data Type
qEnter a search query to return results containing the query.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’.
Enter 0 (zero) or leave blank not to limit.

Integer
count Limit the result set to a defined Integer of results. Integer
directionThe sort direction.String
withPermissions

Includes a list of permissions.

Bool
[
  {
    "address": "string",
    "permissionsSummary": Integer
  }
]

Properties

PropertyDescription
addressThe ElastiCube address.
permissionsSummaryA list of permissions.

Error Status Codes

HTTP Status Code
Reason
403Forbidden
/elasticubes/servers/{server}

Parameters

Parameter
Mandatory
Description
Data Type
serverYesThe server address. The default value that you can enter is localhost.String
qNo

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
offsetNoDefines how many items to skip before returning the results. For example, to return results from value #101 onward, enter a value of ‘100’.Integer
countNo

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

Integer
orderByNoOrders the results by field name. You can add multiple sort fields separated by a comma delimiter ','String
directionNoThe sort direction.String
[
  {
    "createdUtc": "dateTime",
    "databaseName": "aCountries",
    "lastBuiltUtc": "Datetime",
    "permissionsSummary": int,
    "sizeInMb": float,
    "status": int,
    "title": "string"
  }
]

Properties

PropertyDescription
_idInternal reference number.
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.

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

514 - 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
/elasticubes/servers/{server}/simple

Parameters

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

Error Status Codes

HTTP Status Code
Reason
403Forbidden
/elasticubes/servers/{server}/status

Parameters

Parameter
Mandatory
Description
Data Type
serverYesThe ElastiCube's server addressString
qNoEnter a search query to return results containing the queryString
offsetNoDefines how many items to skip before returning the results. For example, to return results from value #101 onward, enter a value of ‘100’.Integer
countNo

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

Integer
orderByNo

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

String
directionNoThe sort direction.String
[
  {
    "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

514 - 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
/elasticubes/{server}/{elasticube}/datasecurity

Click here to learn more about Sisense data security.

Parameters

Parameter
Mandatory
Description
Data Type
serverYesThe ElastiCube's server address.String
elasticubeYesThe 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'.
 [
  {
    "_id": "objectId",
    "allMembers": bool,
    "column": "string",
    "cubeId": "objectId",
    "datatype": "text",
    "members": [],
    "server": "LocalHost",
    "shares": [
      {
        "type": "default"
      }
    ],
    "table": "string"
  }
]

Properties

PropertyDescription
_IdInternal reference ID.
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
/elasticubes/{server}/{cube}/{user}/datasecurity

Parameters

Parameter
Mandatory
Description
Data Type
serverYesThe ElastiCube's server address. The default server address is localhost.String
cubeYesThe ElastiCube's name as displayed in the ElastiCube Manager.String
userYesThe user's ID or username, such as [email protected]String
[
  {
    "_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).
table The table in the ElastiCube.

Error Status Codes

HTTP Status Code
Reason
400Invalid ElastiCube identifier
403Forbidden
/elasticubes/{server}/{elasticube}/datasecurity/{table}/{column}

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

Error Status Codes

HTTP Status Code
Reason
400invalid ElastiCube identifier
403forbidden
/elasticubes/{server}/{elasticube}/permissions

Parameters

Parameter
Value
Description
Data Type
servermandatoryThe ElastiCube's server address.string
elasticubemandatoryThe name or ID of the ElastiCubestring
{
  "server": "string",
  "title": "string",
  "shares": [
    {
      "permission": "string",
      "party": "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.

party - 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
/elasticubes/{server}/{elasticube}/start

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
/elasticubes/{server}/{elasticube}/stop

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
/elasticubes/{server}/{elasticube}/restart

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
/elasticubes/{server}/{elasticube}/startBuild

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 - Updates the ElastiCube server with the ElastiCube schema, without building.

Full - Rebuilds the ElastiCube from scratch.

Delta - Rebuilds from scratch tables that have changed in the ElastiCube schema.

FullUpdateExisting - R ebuilds the ElastiCube and accumulates data for tables marked as accumulative. This mode should only be used for accumulative builds.

string

Error Status Codes

HTTP Status Code
Reason
400invalid server
400invalid elasticube
403forbidden
/elasticubes/{server}/{elasticube}/stopBuild

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
/elasticubes/{elasticube}/jaql

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

{

  "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
/elasticubes/{server}/{elasticube}/datasecurity

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
bodymandatoryThe data security object that needs to be updated.
[
  {
    "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:

  • party - 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
/elasticubes/datasecurity

Parameters

ParameterValueDescriptionData Type
List[elasticubeNewDataSecurityItem]mandatory
The data security object that needs to be updated.
[
{
"allMembers": true,
"column": "string",
"datatype": "string",
"elasticube": "string",
"exclusionary": true,
"members": [
"string"
],
"server": "string",
"shares": [
{
"party": "string",
"type": "string"
}
],
"table": "string"
}
]

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:

party - 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
/elasticubes/{server}/{elasticube}/attachDetach

Parameters

ParameterValueDescriptionData Type
servermandatoryThe server address of the ElastiCube.string
elasticubemandatoryThe name of the ElastiCube.string
body


{
  "dataDirectory": "string",
  "deleteOnDetach": true,
  "sync": true
}

Properties

PropertyDescription
dataDirectoryThe directory where the ElastiCube is located. You can view the path of this directory in the Server Console.
deleteOnDetachBoolean value that determines if the ElastiCube should be deleted after being detached. The default value is true.
syncBoolean value that determines whether to execute this synchronously or asynchronously. The default value is true, synchronously.


Error Status Codes

HTTP Status CodeReason
400invalid server
400invalid cube ID
403forbidden
/elasticubes/{server}/{elasticube}/permissions

Parameters

ParameterValueDescriptionData Type
servermandatoryThe server address of the ElastiCube.string
elasticubemandatoryThe name of the ElastiCube.string
shares

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

[
  {
    "permission": "string",
    "party": "string",
    "type": "string"
  }
]

Properties

PropertyDescription
permission
partyThe 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
/elasticubes/{server}/{elasticube}/permissions

Parameters

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

Properties

PropertyDescription
permission
partyThe 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
/elasticubes/server/{server}/permissions

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).
[
  {
    "permission": "string",
    "party": "string",
    "type": "string"
  }
]

Properties

PropertyDescription
permission
partyThe 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
/elasticubes/{server}/{elasticube}/datasecurity/{table}/{column}

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
/elasticubes/{server}/{elasticube}/permissions

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

/users

Parameters

ParameterValueDescriptionData Type
limit
Limits the result set to a defined Integer 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
[
  {
    "_id": "ObjectId",
	"active": bool,
    "userName": "string",
    "roleId": "ObjectId",
    "email": "string",
    "firstName": "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
/users/ad

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

Parameters

ParameterValueDescriptionData Type
limit
Limits the result set to a defined Integer 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
[
  {
    "_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
/users/allDirectories

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 Integer of results

Enter 0 (zero) or leave blank not to limit.
int
search
Enter a search query to return results matching the query.string
[
  {
    "_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
/users/count

Returns the Integer 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
{
  "collection": "string",
  "count": int
}

Properties

PropertyDescription
collectionInternal reference
countThe Integer of users.

Error Status Codes

HTTP Status Code
Reason
400invalid search
400invalid limit
403forbidden
/users/{user}

Parameters

ParameterValueDescriptionData Type
userMandatoryThe user's ID or usernamestring
{
  "_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
/users/loggedin
{
  "_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.
roleId Internal reference
preferencesIndicates locale preferences.

userAuth

A list of permissions for the user.

Error Status Codes

HTTP Status CodeReason
403forbidden

Actions

/users/simulate

Note: This operation does not add users.

Parameters

ParameterValueDescriptionData Type
List[email/usernames]Mandatory
The list of user emails to add, or usernames for Active Directory mode.
[
  {
    "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.


admode
Enter True to simulate adding users from Active Directory.bool

Error Status Codes

HTTP Status CodeReason
400invalid input
403forbidden
/users

Parameters

ParameterValueDescriptionData Type
List[user]Mandatory

The user object includes all the user information.

Model 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
/users/ad

Parameters

ParameterValueDescriptionData Type
userMandatory
The user object that needs to be added to the directory.
{
  "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
/users/forgetpassword

Parameters

ParameterValueDescriptionData Type
userEmailMandatory
The email of the user that requires a password reset.

Model Schema

{
  "email": "string"
}

 Properties

PropertyDescription
emailThe user's email.


Error Status Codes

HTTP Status CodeReason
403forbidden
/users/delete

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
/users/validate

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
/users/{user}

Parameters

ParameterValueDescriptionData Type
userMandatoryThe user's ID or username.string
userUpdateMandatoryThe user object that needs to be updated.
{
  "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
/users/{user}

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

/groups

Parameters

ParameterValueDescriptionData Type
limit

Limits the result set to a defined Integer 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 Integer of users in each group.boolean
[
  {
    "_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
/groups/ad

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

Parameters

ParameterValueDescriptionData Type
limit

Limits the result set to a defined Integer 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.
[
  {
    "_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
/groups/allDirectories

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

Parameters

ParameterValueDescriptionData Type
limit

Limits the result set to a defined Integer 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 Integer of users per group.boolean
[
  {
    "_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
/groups/{group}

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
{
  "_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
/groups/{group}/users

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
[
  {
    "_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

/groups/byIds

Parameters

ParameterValueDescriptionData Type
List[ObjectId]MandatoryList of user IDsstring
usersCount
Returns the Integer of users per group.Boolean
[
  {
    "_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
/groups

Parameters

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

Error Status Codes

HTTP Status CodeReason
400Invalid input
403forbidden
/groups/ad

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.
[
  {
    "_id": "ObjectId",
    "objectSid": "array/buffer",
    "cn/name": "string",
    "dn": "string",
    "uSNChanged": "string",
    "mail": "string",
    "roleId": "ObjectId",
    "created": "dateTime",
    "lastUpdated": "dateTime"
  }
]
[
  [
    {
      "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
/groups/{group}/users

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
/groups/validateName

Parameters

ParameterValueDescriptionData Type
groupMandatoryThe name of the group to validate
{
  "name": "string"
}

Properties

PropertyDescription
nameThe name of the user group.


Error Status Codes

HTTP Status CodeReason
400Invalid ID
404ID not found
403forbidden
/groups/{group}

Parameters

ParameterValueDescriptionData Type
groupMandatoryThe group's ID or name.

string

Error Status Codes

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

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
/groups/{group}

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
/groups/{group}/users

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

/auth/logout

Error Status Codes

HTTP Status Code
Reason
400Invalid ID
403forbidden
/auth/isauth
 {
  "isAuthenticated": bool
}

Properties

PropertyDescription

isAuthenticated

Indicates whether the user is logged in or not.

Branding

Metadata

/branding

This endpoint lists all changes made to your branding metadata. If no changes have been made and the default Sisense branding is used, an empty response with Response Code 200 is returned.

For more information about branding, see Rebranding Sisense.

[
  {
  "logo": {
    "desktop": {
      "small": "string",
      "large": "string"
    },
    "tablet": {
      "small": "string",
      "large": "string"
    },
    "phone": {
      "small": "string",
      "large": "string"
    }
  },
  "favicon": "string",
  "pageTitle": "string",
  "loginTitle": "string",
  "loginSubtitle": "string",
  "activationTitle": "string",
  "activationSubtitle": "string",
  "contactUsText": "string",
  "copyrightText": "string",
  "homePage": "string",
  "homePageConfig": {
    "hideSearchInNavver": true,
    "marketingPart": "string",
    "tutorialsLink": "string",
    "documentationLink": "string"
  },
  "emails": {
    "senderEmail": "string",
    "senderName": "string",
    "templates_directory": "string",
    "passwordRecoverySubject": "string",
    "newUserInviteSubject": "string",
	"createdUserSubject": "string",
    "shareWithNewUserSubject": "string",
    "shareWithExistingUser": "string",
    "transferOwnership": "string"
  },
  "documentationUrl": "string",
  "forumUrl": "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 ".

homePageConfig

The Welcome banner of the homepage displayed when users log into Sisense.

You can define the following properties in the homePageConfig object:
hideSearchInNavver: Indicate if you want to display the Search bar below or hide it. By default, the Search bar is displayed.
marketingPart: The URL of the Marketing Banner iFrame. This iFrame is displayed on the top half of the Analytics and Data pages where the Welcome message and Sample Dashboards and ElastiCubes are displayed. You can replace this iFrame with your own content by defining the URL as the value of this key.
tutorialsLink: Enter a URL that opens your site.
documentationLink: Enter a URL that opens your documentation site.

emails

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",

"createdUserSubject" : "Sisense new user created email",

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

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

"transferOwnership" : "The Subject line of the Transfer Ownership automated email that is sent to the new owner of a dashboard when ownership is transferred."

documentationUrlA URL that redirects user's to your documentation set.
forumUrlA URL that redirects user's to your forum.

Error Status Codes

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

Actions

/branding

This endpoint changes your branding metadata to reflect your company's branding. If no changes have been made and the default Sisense branding is used.

For more information about branding, see Rebranding Sisense.

Parameters

ParameterValueDescriptionData Type
brandingMandatory

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

[
{
  "logo": {
    "desktop": {
      "small": "string",
      "large": "string"
    },
    "tablet": {
      "small": "string",
      "large": "string"
    },
    "phone": {
      "small": "string",
      "large": "string"
    }
  },
  "favicon": "string",
  "pageTitle": "string",
  "loginTitle": "string",
  "loginSubtitle": "string",
  "activationTitle": "string",
  "activationSubtitle": "string",
  "contactUsText": "string",
  "copyrightText": "string",
  "homePage": "string",
  "homePageConfig": {
    "hideSearchInNavver": true,
    "marketingPart": "string",
    "tutorialsLink": "string",
    "documentationLink": "string"
  },
  "emails": {
    "senderEmail": "string",
    "senderName": "string",
    "templates_directory": "string",
    "passwordRecoverySubject": "string",
    "newUserInviteSubject": "string",
	"createdUserSubject": "string",
    "shareWithNewUserSubject": "string",
    "shareWithExistingUser": "string",
    "transferOwnership": "string"
  },
  "documentationUrl": "string",
  "forumUrl": "string"
}
]

Properties

PropertyDescription
logoThe paths to the logo images.
pageTitleText 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 ".

homePageConfig

The Welcome banner of the homepage displayed when users log into Sisense.

You can define the following properties in the homePageConfig object:
hideSearchInNavver: Indicate if you want to display the Search bar below or hide it. By default, the Search bar is displayed.
marketingPart: The URL of the Marketing Banner iFrame. This iFrame is displayed on the top half of the Analytics and Data pages where the Welcome message and Sample Dashboards and ElastiCubes are displayed. You can replace this iFrame with your own content by defining the URL as the value of this key.
tutorialsLink: Enter a URL that opens your site.
documentationLink: Enter a URL that opens your documentation site.

emails

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",

"createdUserSubject" : "Sisense new user created email",

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

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

"transferOwnership" : "The Subject line of the Transfer Ownership automated email that is sent to the new owner of a dashboard when ownership is transferred."
documentationUrlA URL that redirects user's to your documentation set.
forumUrlA URL that redirects user's to your forum.

 

[
  {
  "logo": {
    "desktop": {
      "small": "string",
      "large": "string"
    },
    "tablet": {
      "small": "string",
      "large": "string"
    },
    "phone": {
      "small": "string",
      "large": "string"
    }
  },
  "favicon": "string",
  "pageTitle": "string",
  "loginTitle": "string",
  "loginSubtitle": "string",
  "activationTitle": "string",
  "activationSubtitle": "string",
  "contactUsText": "string",
  "copyrightText": "string",
  "homePage": "string",
  "homePageConfig": {
    "hideSearchInNavver": true,
    "marketingPart": "string",
    "tutorialsLink": "string",
    "documentationLink": "string"
  },
  "emails": {
    "senderEmail": "string",
    "senderName": "string",
    "templates_directory": "string",
    "passwordRecoverySubject": "string",
    "newUserInviteSubject": "string",
    "shareWithNewUserSubject": "string",
    "shareWithExistingUser": "string",
    "transferOwnership": "string"
  },
  "documentationUrl": "string",
  "forumUrl": "string"
}     
]

Error Status Codes

HTTP Status CodeReason
400Invalid input
403forbidden
/branding

This endpoint deletes custom branding and returns to the default Sisense branding. When you delete custom branding, the Sisense Web Application is displayed in Sisense branding and Sisense automatic emails are sent.

Error Status Codes

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

Settings

/settings/api
{
  "_id": "string",
  "apiKey": "string"
}

Properties

PropertyDescription
_idInternal reference
apiKeyAPI Global token. For more information, see Authenticating Requests with a Global Token.

Error Status Codes

HTTP Status CodeReason
404name not found
403fobidden
/settings/system
{
  "_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
/settings/system

Parameters

ParameterValueDescriptionData Type
systemConfigMandatorysystem configuration
{
  "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.

webSever

Returns web server details.

enableSSL - Boolean value that enables SSL connections.

cors - Allows the client's browser to make requests to the Sisense server after requesting resources from your domain.

enabled - Boolean value that enables CORS (Cross-origin Resource Sharing).

allowOrigins - Domains where cross-origin resource sharing is permitted.



Error Status Codes

HTTP Status CodeReason
400invalid input
403forbidden
/settings/proxy

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

Parameters

{
  "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 Integer of the proxy.
username

The username of the proxy.

passwordThe password required for the proxy.
/settings/proxy

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

{
  "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 Integer of the proxy.
username

The username of the proxy.

passwordThe password of the proxy.

Error Status Codes

HTTP Status CodeReason
403forbidden
400invalid proxy
/settings/proxy

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

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

{
  "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 Integer of the proxy.
username

The username of the proxy.

passwordThe password of the proxy.


Error Status Codes

HTTP Status CodeReason
403forbidden
400invalid proxy
 /settings/proxy


/settings/security
{
  "_id": "objectId",
  "name": "string",
  "allowAddServers": bool
}

Properties

PropertyDescription
name The name of the security configuration settings.
allowAddServers

Error Status Codes

HTTP Status Code
Reason
404name not found
403forbidden

/settings/security

Parameters

ParameterValueDescriptionData Type
securityConfigMandatorySecurity configuration
{
  "_id": "ObjectId",
  "secureCookie": true,
  "cookieExp": "int",
  "passwordRegex": "string"
}

Properties

PropertyDescription
secureCookie

A boolean that adds a "secureFlag" to cookies of users who connect to the Sisense Web Application. This flag instructs the browser that the cookie should only be returned to the Sisense Web Application over encrypted connections (HTTPS).

cookieExpThe cookie expiration in days for the user's login. The default value is 30 days. You canchange this value by enter the number of days that must pass until Sisense logs a user out.
passwordRegex

Regex expression that defines your password policy. If you do not want to define a password policy, remove this property from your call.

Note: If you leave a "string" value for the "passwordRegex" property, users can't add new users or change password to existing users.

See the examples below of common password configurations:

Strong password with at least one lowercase letter, one uppercase letter, one numeral, and one special character whose length is between 6-10 characters.

(?=^.{6,10}$)(?=.*\d)(?=.*[a- z])(?=.*[A-Z])(?=.*[[email protected]#$%^& amp;*()_+}{":;'?/>.& lt;,])(?!.*\s).*$

Weak password with at least 6 characters.

^.{6,}$

Sisense default password policy that requires at least 8 characters and one letter, one numeral, and one special character.

^(?=.*\\d)(?=.*[a-zA-Z])(?=.*[ [email protected]#$%^&*_\\-+={}\\[\\]()<>`\' ".,:;\\/|]).{8,255}$  

passwordErrorError message to be displayed when an error occurs.

Error Status Codes

HTTP Status CodeReason
400invalid input
403forbidden
/settings/api/generate
{
  "_id": "string",
  "apiKey": "string"
}

Properties

PropertyDescription
_idInternal reference
apiKeyAPI Global token. For more information, see Authenticating Requests with a Global Token.

Error Status Codes

HTTP Status CodeReason
404name not found
403fobidden
/settings/globalization
{
  "_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.

/settings/globalization

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

Parameters

ParameterValueDescriptionData Type
globalizationConfigMandatoryThe globalization configuration to edit.
{
  "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

/settings/api


{
  "_id": "string",
  "apiKey": "string"
}

Properties

PropertyDescription
_idInternal reference
apiKeyAPI Global token. For more information, see Authenticating Requests with a Global Token.

Error Status Codes

HTTP Status CodeReason
404name not found
403fobidden

Reporting

/reporting

Parameters

ParameterValueDescriptionData Type
sendReportsMandatoryreporting object describing the report you want
{
  "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

 /roles

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
[
  {
    "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).
compiledRoleTrue returns the full list of role permissions. False returns the compiled base role name.

Error Status Codes

HTTP Status CodeReason
403forbidden
/roles/{idOrName}

Parameters

ParameterValueDescriptionData Type
idOrNameMandatoryThe name or ID of the role.string
compiledRole
True returns the full list of role permissions. False returns the compiled base role name. boolean
{
  "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
/roles


/roles/{idOrName}

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
/roles/{idOrName}

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.

{
  "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
/roles/{idOrName}/manifest/{path}
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 returns 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
/roles/{idOrName}/manifest/{path}

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. For 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
/roles/{idOrName}/manifest/{path}
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. For 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
/roles/{idOrName}/manifest/{path}

Adds new manifest keys overriding the existing keys (permissions). If you update only some keys, the other keys are 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. For 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

/palettes
[
  {
    "_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
/palettes/default
{
  "_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

/palettes

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.
{
  "colors": [
    "string"
  ],
  "min": "string",
  "max": "string",
  "name": "string",
  "isDefault": "bool",
  "sortOrder": "Integer"
}

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
/palettes/{name}

Parameters

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

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
/palettes/{name}

Parameters

Parameter
Value
Description
Data Type
nameMandatory Palette's namestring

Error Status Codes

HTTP Status Code
Reason
403forbidden