IDashboardQuery
Beta API. Mostly stable, but details may change in a minor release, outside SemVer. See API maturity.
Base type for all dashboard queries. A dashboard query encapsulates how complex, read-only dashboard-specific logic can be can be executed.
export interface IDashboardQuery
Properties
Property | Modifiers | Type | Description |
|---|---|---|---|
| string | (BETA) (Optional) Correlation ID can be provided when creating a query. Events emitted during the query processing will contain the same correlation ID. | |
| (BETA) Query type. Always starts with “GDC.DASH/QUERY”. |
Property details
IDashboardQuery.correlationIdpropertyBeta
Beta API. Mostly stable, but details may change in a minor release, outside SemVer. See API maturity.
Correlation ID can be provided when creating a query. Events emitted during the query processing will contain the same correlation ID.
readonly correlationId?: string;
IDashboardQuery.typepropertyBeta
Beta API. Mostly stable, but details may change in a minor release, outside SemVer. See API maturity.
Query type. Always starts with “GDC.DASH/QUERY”.
readonly type: DashboardQueryType;