Skip to content

The easy-to-use open source Business Intelligence and Embedded Analytics tool that lets everyone work with data :bar_chart:

2.7 KB
Raw Blame
type SdkDashboardEntityPublicProps =
  | {
      dashboardId: SdkDashboardId | null;
      token?: never;
    }
  | {
      dashboardId?: never;
      token: SdkEntityToken | null;
    };

Type Declaration

{
  dashboardId: SdkDashboardId | null;
  token?: never;
}
Name Type Description
dashboardId SdkDashboardId | null The ID of the dashboard.
This is either:
- the numerical ID when accessing a dashboard link, i.e. http://localhost:3000/dashboard/1-my-dashboard where the ID is 1
- the string ID found in the entity_id key of the dashboard object when using the API directly or using the SDK Collection Browser to return data
token? never -
{
  dashboardId?: never;
  token: SdkEntityToken | null;
}
Name Type Description
dashboardId? never -
token SdkEntityToken | null A valid JWT token for the guest embed.