Skip to content

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

8.2 KB
Raw Blame
type SdkQuestionEntityPublicProps =
  | {
      card?: never;
      query?: never;
      questionId: SdkQuestionId | null;
      token?: never;
    }
  | {
      card?: never;
      query?: never;
      questionId?: never;
      token: SdkEntityToken | null;
    }
  | {
      card: string | MetabaseCard;
      query?: never;
      questionId?: never;
      token?: never;
    }
  | {
      card?: never;
      query: MetabaseQueryObject | null;
      questionId?: never;
      token?: never;
    };

Type Declaration

{
  card?: never;
  query?: never;
  questionId: SdkQuestionId | null;
  token?: never;
}
Name Type Description
card? never -
query? never -
questionId SdkQuestionId | null The ID of the question.
This is either:
- the numerical ID when accessing a question link, i.e. http://localhost:3000/question/1-my-question where the ID is 1
- the string ID found in the entity_id key of the question object when using the API directly or using the SDK Collection Browser to return data
- new to show the notebook editor for creating new questions
- new-native to show the SQL editor for creating new native questions
token? never -
{
  card?: never;
  query?: never;
  questionId?: never;
  token: SdkEntityToken | null;
}
Name Type Description
card? never -
query? never -
questionId? never -
token SdkEntityToken | null A valid JWT token for the guest embed.
{
  card: string | MetabaseCard;
  query?: never;
  questionId?: never;
  token?: never;
}
Name Type Description
card string | MetabaseCard An ad-hoc question to render without saving it first. Either a MetabaseCard object, or a serialized card string copied from a question URL hash (/question#<base64> or the bare base64).
query? never -
questionId? never -
token? never -
{
  card?: never;
  query: MetabaseQueryObject | null;
  questionId?: never;
  token?: never;
}
Name Type Description
card? never -
query MetabaseQueryObject | null A table-backed ad hoc query created with useMetabaseQueryObject.
questionId? never -
token? never -