With the Sisense REST API, you and your customers can send email reports with your users and groups programmatically through your native application.

Email reports contain static versions of a dashboard that can be clicked to access the dashboard or PDFs containing images of your dashboard.

Both versions of the REST API support reporting. Version .9 was developed prior to Sisense 6.0 whereas Version 1.0 was designed afterwards and has improved endpoints.

The send report endpoint receives asset info and recipients list and sends an email report.

Note: The users and groups in the recipients section must be shared to the dashboard.

API Version .9

Property TypeDescription
assetId StringThe ID of the dashboard to be shared with your users.
assetTypeStringDefines the type of asset to be shared. Currently, the only available value is “dashboard”.
recipientsArrayAn array containing two string objects:

recipients.type: The type of recipient, user or group.
recipients.recipient: The name or ID of the group when recipient.type is group. When recipient.type is user, the ID or username of the user.

API Version 1.0

Property TypeDescription
authorizationHeaderThe user's unique ID generated by Sisense.
reportObjectBodyAn object containing the data needed in order to send the report. AssetId being the dashboard ID and the recipients array should contain the user's /group's ID along with its type. The preferences section describes the content of the Email to be sent.

assertId: The ID of the dashboard to be shared with your users.
assetType: The type of asset to be shared. Currently, the only available value is “dashboard”. recipients.type: The type of recipient, user or group.
recipients.recipient: The name or ID of the group when recipient.type is group. When recipient.type is user, the ID or username of the user.
inline: A boolean value that determines if the report is sent inline or as a PDF attachment. True equals inline, false, as an attachment.
pdf: Object that defines how the report is displayed in the email.
includeTitle: Boolean that determines if the title of the report is displayed or not.
includeFilters: Boolean that determines if the filters of the report are displayed or not.
includeDS: Boolean that determines if the datasource name is displayed in the email.
renderingInfo: Object that determines how the report is to be displayed in the email.
paperFormat: The size of the email report in the PDF, A3 or A4.
paperOrientation: The orientation of the PDF report, landscape or portrait.
layout: Determines how the dashboard is displayed in the PDF. As Is: The PDF tries to render the dashboard in its original layout, as it is presented on the screen. Feed: Widgets are rendered one below the other in a feed-like manner.
fieldsQueryWhitelist of fields to return for each document. You can also define which fields to exclude by prefixing field names with -.
expandQueryList of fields that should be expanded (substitutes their IDs with actual objects). May be nested using theresource.subResourceformat