Report results export API
eazyBI provides a report result export URL that you can use to execute the specified report and download the report results:
- Atlassian Server and Data Center:
- Atlassian Cloud:
- Private eazyBI:
<eazyBI host and port>/eazybi/accounts/account_id/export/report/report_id.format
Please replace the
JIRA_BASE_URL as well as the following parameters:
account_id– ID of the corresponding eazyBI account (visible in URLs after
report_id– ID of the eazyBI report (when you open the report in the Analyze tab then visible in URL after
When using eazyBI for Jira Cloud then use the Embed report action to see the
report_idof the report (replace
exportin the URL).
format– specify one of the following supported formats in which you would like to download the results:
When using eazyBI for Jira Server please setup export to PDF to enable pdf and png formats.
If your reports contain page filters you can dynamically set value for those filters by passing the value in URL.
selected_pages– an optional parameter, one or several full member names separated by a comma for page dimensions. The full member name contains dimension name and eazyBI will automatically match members to page dimension. Please see below example URL with pre-set time and project page filter:
../accounts/99/export/report/42.xls?selected_pages=[Time].,[Project].[Live Demos],[Project].[Active Objects]
At first, test the report results export in your browser and see if it returns expected results. If you would like to automate report results export requests from other applications then you need to provide authentication information for these requests.
Note this export API works for retrieving a report data but does not work for a dashboard. More details on options to download dashboard data read here: Create dashboards.
Report results export API support either HTTP Basic authentication or embed report token authentication.
- Atlassian Server and Data Center
Make the request using Basic authentication with your Jira / Confluence username and password. Jira / Confluence will validate the username and password and eazyBI will validate if this user has access to the eazyBI account and the specific report.
- Atlassian Cloud
- Embed report token
If you have shared the report with a public token then you can add the request parameter
?embed_token=... with the corresponding generated token to authenticate the result export request.
When using basic authentication in scripts, it is recommended to use a separate user with limited read-only access rights, as this user's password or API token will be stored in those scripts.
When creating an API token in Atlassian Cloud, it is recommended to create a separate token with a meaningful name (e.g. eazyBI). Then it will be possible to see when this token was used and revoke it if not needed anymore.
MultiPass authentication for Private eazyBI
Please see MultiPass authentication documentation on how you can set up and create MultiPass tokens.
You can use MultiPass authentication if you would like to create automated scripts which download eazyBI report results:
- When creating the MultiPass token, you need to include in it
toattribute which is relative URL of the results export:
- Make the request to the following URL (replace the
site_keywith the corresponding name you used in eazybi.toml):
<eazyBI host and port>/eazybi/users/multipass/site_key?multipass=multipass_token
- After successful authentication, the request will be redirected to the report results export URL.
Sample node.js script
At first, you need to
- install Node.js
- install node-rest-client with the following command:
npm install node-rest-client
Then create the attached script file
eazybi-export-results.js and update in it Jira base URL and basic authentication parameters. Then use it in the following way:
format as described in the overview. Report results will be written to the standard output, save it to a file if needed.