Skip to Content

End-User Features

Let end users save dashboards

Let each customer save their own boards, or create a dashboard for a customer from your backend.

You have two ways. End users save boards themselves inside the embed. Or your backend creates a dashboard for one client with the API.

Let end users save boards

A board is a saved copy of the dashboard with the viewer’s filters.

  1. Open the dashboard in the workspace, open its settings and turn on Enable board.
  2. Go to Data Studio > Data Apps and open the data app.
  3. Open Embed info and select the dashboard embed in Embeds.
  4. On Access control, turn on Create boards and select Save.
  5. In your backend, send params.userIdentifier in every guest token, for example "userIdentifier": "jane@acme.example".

End users can now save boards. Boards are saved for future visits.

To turn boards on or off for one token, send "permissions": { "isEnableCreateDashboardView": true } or false. The token wins over Create boards.

Create a dashboard for one client

Your backend calls POST https://api.usedatabrain.com/api/v2/dataApp/dashboardEmbed/create with the data app API key. It creates an embed of a new dashboard for one clientId, optionally cloned from templateDashboardId. The request sets the embed’s access settings, such as isAllowMetricCreation and isAllowCreateDashboardView.

See Create Dashboard Embed for the body and the import options.

clientId and userIdentifier

clientId is the tenant and decides which rows people see. userIdentifier is the person. Items a person creates, such as metrics and scheduled reports, belong to their userIdentifier.

If something goes wrong

  • End users do not see the board control. Turn on both Enable board on the dashboard and Create boards on the embed.
  • “Custom SQL metrics cannot be edited by end users.” (HTTP 403). End users can use Custom SQL metrics in their dashboards but cannot edit them.

Related: Let end users create metrics.