Embedded analytics SDK API
    Preparing search index...

    Type Alias SdkDashboardEntityPublicProps

    SdkDashboardEntityPublicProps:
        | { dashboardId: SdkDashboardId
        | null; token?: never }
        | { dashboardId?: never; token: SdkEntityToken | null }

    Type Declaration

    • { dashboardId: SdkDashboardId | null; token?: never }
      • 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
      • Optionaltoken?: never
    • { dashboardId?: never; token: SdkEntityToken | null }
      • OptionaldashboardId?: never
      • token: SdkEntityToken | null

        A valid JWT token for the guest embed.