REST API for Dashboard Export

Login to API

Endpoint (GET):

/session/login

Parameters:

Parameter	Description
`username`	Username of a SKOOR user
`password`	Password of the same user

Example:

https://<SKOOR host>/skoor-webservice/session/login?username=<username>&password=<password>

Logout from API

Please always log out from the API after performing the required actions

Endpoint (GET):

/session/logout

Parameters:

Parameter	Description
`sessionId`	SKOOR session id from session login request

Example:

https://<SKOOR host>/skoor-webservice/session/logout?sessionId=<sessionId>

Parameters for exports

Parameter	Description
`dataQueries`	Export related data queries
`files`	Export related files (e.g. images)
`theme`	Export related themes (e.g. CSS, colors)
`translations`	Export related translation configurations
`sessionId`	SKOOR session id from session login request

Export all dashboards

Endpoint (GET):

/dashboards/groups/root/export

Parameters:

Example:

https://<SKOOR host>/skoor-webservice/dashboards/groups/root/export?dataQueries=true&files=true&theme=true&translations=true&sessionId=<sessionId>

Export dashboard group

Endpoint (GET):

/dashboards/groups/{groupId}/export

Example:

https://<SKOOR host>/skoor-webservice/dashboards/groups/719/export?dataQueries=true&files=true&theme=true&translations=true&sessionId=<sessionId>

Find dashboard group id

To find the id of a group, process an export manually from the required groups menu and select the Plain JSON checkbox in the export dialog:

Then look for the id key in the JSON string:

Export single dashboard

Endpoint (GET):

/dashboards/{dashboardId}/export

Example:

https://<SKOOR host>/skoor-webservice/dashboards/10842/export?dataQueries=true&files=true&theme=true&translations=true&sessionId=<sessionId>

Find dashboard id

As described for dashboard group exports, the dashboard id can be found in the dialog of a manual export. Look for an object of type dashboard and subType dashboard to get the correct id key: