Dashboards tools

list_dashboards

Lists every dashboard visible in a project. Dashboards aggregate multiple analyses into a single page view. The response gives you the name, shared flag, home flag, archived flag, and metadata.

The list is user-scoped — what's returned reflects what the authenticated user has access to. Component layouts are not included here — use get_dashboard for those.

Request parameters

NameTypeRequired?Description
project_idstrYesThe project ID returned by list_projects.

Response parameters

The tool returns a DashboardsResponse object with the following parameters:

ParameterTypeDescription
successboolWhether the request succeeded.
datalist[DashboardSummary]The dashboard summaries.
errorstr | nullError message if the request failed.

The DashboardSummary object has the following fields:

FieldTypeDescription
idstrThe dashboard's unique ID.
namestrThe dashboard's display name.
archivedboolWhether the dashboard has been archived.
sharedboolWhether the dashboard is shared with other users.
homeboolWhether the dashboard is set as the project home page.
createdany | nullUnix timestamp of when the dashboard was created.
created_by_display_namestr | nullDisplay name of the creator.
editedany | nullUnix timestamp of the last edit.
edited_by_display_namestr | nullDisplay name of the last editor.

get_dashboard

Returns the full definition of a single dashboard, including every component configuration (embedded analyses, HTML blocks, images, and so on) in display order.

Request parameters

NameTypeRequired?Description
project_idstrYesThe project ID returned by list_projects.
dashboard_idstrYesThe dashboard ID returned by list_dashboards.

Response parameters

The tool returns a DashboardResponse object with the following parameters:

ParameterTypeDescription
successboolWhether the request succeeded.
dataDashboard | nullThe full dashboard definition with all components.
errorstr | nullError message if the request failed.

The Dashboard object adds the following field on top of the summary record:

FieldTypeDescription
componentslist[any]The dashboard component definitions (analyses, HTML, images, and so on) in display order. Each component has a type, a config, and a layout.


© Bloomreach, Inc. All rights reserved.