> Documentation index: https://www.gooddata.ai/docs/gooddata-ui/llms.txt lists every page of these docs as Markdown. # IInsightDateDatasets - Package: [@gooddata/sdk-ui-dashboard](https://www.gooddata.ai/docs/gooddata-ui/latest/api-reference/sdk-ui-dashboard/index.md) - Kind: interface - Stability: alpha - Source: https://github.com/gooddata/gooddata-ui-sdk/blob/rel/11.64/libs/sdk-ui-dashboard/src/model/queries/insights.ts > **Alpha API.** Initial API, highly likely to change outside SemVer. Don't build on it in production. See [API maturity](https://www.gooddata.ai/docs/gooddata-ui/latest/integrations/platform/api-maturity/index.md). > The insight date datasets is a digest of information related to what date datasets are used by the insight and what date datasets are also relevant to the insight. **Signature:** ```typescript export interface IInsightDateDatasets ``` ## Remarks The relevancy of date datasets is determined by relation of the entities used by the insight (facts, metric, attributes) and the data datasets in the workspace's LDM. The data included herein can be used to select an appropriate date dataset to filter the insight on a dashboard. The `mostImportantFromInsight` date dataset - if available, should be typically picked to use for date filtering. If it is not available (meaning the insight does not directly use anything related to date datasets) then the `dateDatasetsOrdered` can be used to pick the date dataset for filtering. ## Properties | Property | Modifiers | Type | Description | | --- | --- | --- | --- | | [allAvailableDateDatasets](https://www.gooddata.ai/docs/gooddata-ui/latest/api-reference/sdk-ui-dashboard/sdk-ui-dashboard.iinsightdatedatasets/index.md#iinsightdatedatasetsallavailabledatedatasets) | `readonly` | [ICatalogDateDataset](https://www.gooddata.ai/docs/gooddata-ui/latest/api-reference/sdk-model/sdk-model.icatalogdatedataset/index.md)[] | **_(ALPHA)_** All date datasets that can be used to filter the insight. This list is union of all the categorized date datasets listed in this result. | | [dateDatasetDisplayNames](https://www.gooddata.ai/docs/gooddata-ui/latest/api-reference/sdk-ui-dashboard/sdk-ui-dashboard.iinsightdatedatasets/index.md#iinsightdatedatasetsdatedatasetdisplaynames) | `readonly` | Record<string, string> | **_(ALPHA)_** A mapping between original date dataset title and a nicely formatted title that is suitable to display to the end-user. All date datasets that figure in the result structure have their titles included in this mapping | | [dateDatasets](https://www.gooddata.ai/docs/gooddata-ui/latest/api-reference/sdk-ui-dashboard/sdk-ui-dashboard.iinsightdatedatasets/index.md#iinsightdatedatasetsdatedatasets) | `readonly` | ReadonlyArray<[ICatalogDateDataset](https://www.gooddata.ai/docs/gooddata-ui/latest/api-reference/sdk-model/sdk-model.icatalogdatedataset/index.md)> | **_(ALPHA)_** Date datasets that are available for filtering of the insight. The available datasets are obtained by inspecting the LDM entities used in the insight and how they relate to date datasets in the workspace's logical data model. | | [dateDatasetsOrdered](https://www.gooddata.ai/docs/gooddata-ui/latest/api-reference/sdk-ui-dashboard/sdk-ui-dashboard.iinsightdatedatasets/index.md#iinsightdatedatasetsdatedatasetsordered) | `readonly` | ReadonlyArray<[ICatalogDateDataset](https://www.gooddata.ai/docs/gooddata-ui/latest/api-reference/sdk-model/sdk-model.icatalogdatedataset/index.md)> | **_(ALPHA)_** The contents of the `dateDatasets` prop that are ordered according to the relevance. The most relevant and thus most recommended date dataset is first. | | [mostImportantFromInsight](https://www.gooddata.ai/docs/gooddata-ui/latest/api-reference/sdk-ui-dashboard/sdk-ui-dashboard.iinsightdatedatasets/index.md#iinsightdatedatasetsmostimportantfrominsight) | `readonly` | [ICatalogDateDataset](https://www.gooddata.ai/docs/gooddata-ui/latest/api-reference/sdk-model/sdk-model.icatalogdatedataset/index.md) \| undefined | **_(ALPHA)_** Pinpoints the 'most important' date dataset referenced by the insight itself. This may be undefined if the insight does not use any date filtering or does not use any date attribute display form's to filter or slice or dice the results. The importance is evaluated as follows: 1. Date datasets used directly in date filters have the highest importance. Dataset from first-found filter will be used 2. Date datasets that own the display forms used to slice or dice the insight's data have the second-highest importance. Dataset from first-found attribute will be used. 3. Date datasets that own the display forms used for attribute-filtering the insight have the least important. Dataset from first-found attribute filter will be used. | | [usedInAttributeFilters](https://www.gooddata.ai/docs/gooddata-ui/latest/api-reference/sdk-ui-dashboard/sdk-ui-dashboard.iinsightdatedatasets/index.md#iinsightdatedatasetsusedinattributefilters) | `readonly` | ReadonlyArray<[ICatalogDateDataset](https://www.gooddata.ai/docs/gooddata-ui/latest/api-reference/sdk-model/sdk-model.icatalogdatedataset/index.md) \| undefined> | **_(ALPHA)_** Date datasets that the insight references in the attribute filters. The order of appearance matches the order in which attribute display forms used for filtering appear in the [IInsightAttributesMeta](https://www.gooddata.ai/docs/gooddata-ui/latest/api-reference/sdk-ui-dashboard/sdk-ui-dashboard.iinsightattributesmeta/index.md)'s `usage.inFilters`. If some display form does not belong to a date dataset, then the element will be undefined. | | [usedInAttributes](https://www.gooddata.ai/docs/gooddata-ui/latest/api-reference/sdk-ui-dashboard/sdk-ui-dashboard.iinsightdatedatasets/index.md#iinsightdatedatasetsusedinattributes) | `readonly` | ReadonlyArray<[ICatalogDateDataset](https://www.gooddata.ai/docs/gooddata-ui/latest/api-reference/sdk-model/sdk-model.icatalogdatedataset/index.md) \| undefined> | **_(ALPHA)_** Date datasets that the insight references in the attributes used to slice and dice the results. The order of appearance matches the order in which display forms from the data sets appear in the [IInsightAttributesMeta](https://www.gooddata.ai/docs/gooddata-ui/latest/api-reference/sdk-ui-dashboard/sdk-ui-dashboard.iinsightattributesmeta/index.md)'s `usage.inAttributes`. If some display form does not belong to a date dataset, then the element will be undefined. | | [usedInDateFilters](https://www.gooddata.ai/docs/gooddata-ui/latest/api-reference/sdk-ui-dashboard/sdk-ui-dashboard.iinsightdatedatasets/index.md#iinsightdatedatasetsusedindatefilters) | `readonly` | ReadonlyArray<[ICatalogDateDataset](https://www.gooddata.ai/docs/gooddata-ui/latest/api-reference/sdk-model/sdk-model.icatalogdatedataset/index.md)> | **_(ALPHA)_** Date datasets that the insight references in its date filters. Will be empty if the insight does not have any date filters. | ## Property details ### IInsightDateDatasets.allAvailableDateDatasets > **Alpha API.** Initial API, highly likely to change outside SemVer. Don't build on it in production. See [API maturity](https://www.gooddata.ai/docs/gooddata-ui/latest/integrations/platform/api-maturity/index.md). > All date datasets that can be used to filter the insight. This list is union of all the categorized date datasets listed in this result. **Signature:** ```typescript readonly allAvailableDateDatasets: ICatalogDateDataset[]; ``` ### IInsightDateDatasets.dateDatasetDisplayNames > **Alpha API.** Initial API, highly likely to change outside SemVer. Don't build on it in production. See [API maturity](https://www.gooddata.ai/docs/gooddata-ui/latest/integrations/platform/api-maturity/index.md). > A mapping between original date dataset title and a nicely formatted title that is suitable to display to the end-user. All date datasets that figure in the result structure have their titles included in this mapping **Signature:** ```typescript readonly dateDatasetDisplayNames: Record; ``` ### IInsightDateDatasets.dateDatasets > **Alpha API.** Initial API, highly likely to change outside SemVer. Don't build on it in production. See [API maturity](https://www.gooddata.ai/docs/gooddata-ui/latest/integrations/platform/api-maturity/index.md). > Date datasets that are available for filtering of the insight. The available datasets are obtained by inspecting the LDM entities used in the insight and how they relate to date datasets in the workspace's logical data model. **Signature:** ```typescript readonly dateDatasets: ReadonlyArray; ``` ### IInsightDateDatasets.dateDatasetsOrdered > **Alpha API.** Initial API, highly likely to change outside SemVer. Don't build on it in production. See [API maturity](https://www.gooddata.ai/docs/gooddata-ui/latest/integrations/platform/api-maturity/index.md). > The contents of the `dateDatasets` prop that are ordered according to the relevance. The most relevant and thus most recommended date dataset is first. **Signature:** ```typescript readonly dateDatasetsOrdered: ReadonlyArray; ``` ### IInsightDateDatasets.mostImportantFromInsight > **Alpha API.** Initial API, highly likely to change outside SemVer. Don't build on it in production. See [API maturity](https://www.gooddata.ai/docs/gooddata-ui/latest/integrations/platform/api-maturity/index.md). > Pinpoints the 'most important' date dataset referenced by the insight itself. This may be undefined if the insight does not use any date filtering or does not use any date attribute display form's to filter or slice or dice the results. The importance is evaluated as follows: 1. Date datasets used directly in date filters have the highest importance. Dataset from first-found filter will be used 2. Date datasets that own the display forms used to slice or dice the insight's data have the second-highest importance. Dataset from first-found attribute will be used. 3. Date datasets that own the display forms used for attribute-filtering the insight have the least important. Dataset from first-found attribute filter will be used. **Signature:** ```typescript readonly mostImportantFromInsight: ICatalogDateDataset | undefined; ``` ### IInsightDateDatasets.usedInAttributeFilters > **Alpha API.** Initial API, highly likely to change outside SemVer. Don't build on it in production. See [API maturity](https://www.gooddata.ai/docs/gooddata-ui/latest/integrations/platform/api-maturity/index.md). > Date datasets that the insight references in the attribute filters. The order of appearance matches the order in which attribute display forms used for filtering appear in the [IInsightAttributesMeta](https://www.gooddata.ai/docs/gooddata-ui/latest/api-reference/sdk-ui-dashboard/sdk-ui-dashboard.iinsightattributesmeta/index.md)'s `usage.inFilters`. If some display form does not belong to a date dataset, then the element will be undefined. **Signature:** ```typescript readonly usedInAttributeFilters: ReadonlyArray; ``` ### IInsightDateDatasets.usedInAttributes > **Alpha API.** Initial API, highly likely to change outside SemVer. Don't build on it in production. See [API maturity](https://www.gooddata.ai/docs/gooddata-ui/latest/integrations/platform/api-maturity/index.md). > Date datasets that the insight references in the attributes used to slice and dice the results. The order of appearance matches the order in which display forms from the data sets appear in the [IInsightAttributesMeta](https://www.gooddata.ai/docs/gooddata-ui/latest/api-reference/sdk-ui-dashboard/sdk-ui-dashboard.iinsightattributesmeta/index.md)'s `usage.inAttributes`. If some display form does not belong to a date dataset, then the element will be undefined. **Signature:** ```typescript readonly usedInAttributes: ReadonlyArray; ``` ### IInsightDateDatasets.usedInDateFilters > **Alpha API.** Initial API, highly likely to change outside SemVer. Don't build on it in production. See [API maturity](https://www.gooddata.ai/docs/gooddata-ui/latest/integrations/platform/api-maturity/index.md). > Date datasets that the insight references in its date filters. Will be empty if the insight does not have any date filters. **Signature:** ```typescript readonly usedInDateFilters: ReadonlyArray; ```