Skip to main content

Dashboard API

Welcome to the Dashboard API documentation. This API provides a comprehensive set of functions for managing dashboards, reusable widgets, parameter types, and bulk import/export of widgets. Below is a list of available functions, each with a brief description and a link to its detailed documentation.

Function List​

newParameterType​

Generates an empty non-persisted Dashboard Widget Parameter Type to provide the structure required by the API to save a new record into the database. This method must be combined with the saveParameterType method in order to persist the record. Returns a JSON representation of the newly created parameter type object.

getParameterType​

Retrieves a Dashboard Widget Parameter Type by its ID. Returns a JSON representation of the parameter type.

getParameterTypeByName​

Retrieves a Dashboard Widget Parameter Type by its unique name. Returns a JSON representation of the parameter type.

getParameterTypes​

Retrieves a list of all Dashboard Widget Parameter Types. Returns a list of JSON objects representing parameter types.

saveParameterType​

Creates or updates a Dashboard Widget Parameter Type in the system based on the provided parameters. Returns a JSON representation of the saved parameter type.

validateParameterType​

Validates the specified parameters for a Dashboard Widget Parameter Type and returns any validation errors. This only checks if the object can be saved based on the attributes given. Returns a JSON object where keys are field names and values are lists of validation violation messages.

deleteParameterType​

Deletes a Dashboard Widget Parameter Type by its ID. If successful, an ApiResponse Object is returned with the success bool set True.

newWidget​

Generates an empty non-persisted Dashboard Widget to provide the structure required by the API to save a new record into the database. This method must be combined with the saveWidget method in order to persist the record. Returns a JSON representation of the newly created widget object.

getWidget​

Retrieves a Dashboard Widget by its ID. Returns a JSON representation of the widget.

getWidgetByName​

Retrieves a Dashboard Widget by its unique name. Returns a JSON representation of the widget.

getWidgets​

Retrieves a list of all Dashboard Widgets. Returns a list of JSON objects representing widgets.

getAllWidgetNames​

Retrieves the names of all registered Dashboard Widgets. Returns a list of Strings.

saveWidget​

Creates or updates a Dashboard Widget in the system based on the provided parameters. Returns a JSON representation of the saved widget.

saveWidgetAndParameters​

Saves a Dashboard Widget and its parameters in one call. Parameters provided are saved or updated; any existing parameters not in the list are removed. Returns a JSON representation of the saved widget.

validateWidget​

Validates the specified parameters for a Dashboard Widget and returns any validation errors. This only checks if the object can be saved based on the attributes given. Returns a JSON object where keys are field names and values are lists of validation violation messages.

saveWidgets​

Saves a list of Dashboard Widgets in bulk (useful for gateway startup). Returns a list of JSON objects representing the saved widgets.

deleteWidget​

Deletes a Dashboard Widget by its ID. If successful, an ApiResponse Object is returned with the success bool set True.

getWidgetParameters​

Retrieves all parameters for a specific Dashboard Widget. Returns a list of JSON objects representing widget parameters.

newWidgetParameter​

Generates an empty non-persisted Dashboard Widget Parameter to provide the structure required by the API to save a new record into the database. This method must be combined with the saveWidgetParameter method in order to persist the record. Returns a JSON representation of the newly created widget parameter object.

getWidgetParameter​

Retrieves a Dashboard Widget Parameter by its ID. Returns a JSON representation of the widget parameter.

saveWidgetParameter​

Creates or updates a Dashboard Widget Parameter in the system based on the provided parameters. Returns a JSON representation of the saved widget parameter.

validateWidgetParameter​

Validates the specified parameters for a Dashboard Widget Parameter and returns any validation errors. This only checks if the object can be saved based on the attributes given. Returns a JSON object where keys are field names and values are lists of validation violation messages.

deleteWidgetParameter​

Deletes a Dashboard Widget Parameter by its ID. If successful, an ApiResponse Object is returned with the success bool set True.

newDashboard​

Generates an empty non-persisted Dashboard to provide the structure required by the API to save a new record into the database. This method must be combined with the saveDashboard method in order to persist the record. Returns a JSON representation of the newly created dashboard object.

getDashboard​

Retrieves a Dashboard by its ID. Returns a JSON representation of the dashboard.

getDashboardByUrl​

Retrieves a Dashboard by its URL for the current authenticated user (public dashboards are also considered). Returns a JSON representation of the dashboard.

getDashboardsForCurrentUser​

Retrieves all dashboards owned by the current authenticated user, plus all public dashboards. Returns a list of JSON objects representing dashboards.

saveDashboard​

Creates or updates a Dashboard in the system based on the provided parameters. Returns a JSON representation of the saved dashboard.

validateDashboard​

Validates the specified parameters for a Dashboard and returns any validation errors. This only checks if the object can be saved based on the attributes given. Returns a JSON object where keys are field names and values are lists of validation violation messages.

deleteDashboard​

Deletes a Dashboard by its ID. If successful, an ApiResponse Object is returned with the success bool set True.

isUrlUnique​

Checks whether a dashboard URL is unique for a given username (and not used by any public dashboard), with an optional excludeId for updates. Returns a boolean.

exportWidgetsAsJson​

Exports Dashboard Widgets as raw bytes in JSON format (UTF-8 encoded). Use without parameters to export all widgets or pass a list of IDs or names to export only selected widgets.

exportWidgetsAsCsv​

Exports Dashboard Widgets as raw bytes in CSV format (UTF-8 encoded). Use without parameters to export all widgets or pass a list of IDs or names to export only selected widgets.

importFromCsv​

Imports Dashboard Widgets from a CSV file provided as raw bytes. Returns an ApiResponse with outcome details.

importFromJson​

Imports Dashboard Widgets from a JSON file provided as raw bytes. Returns an ApiResponse with outcome details.