IDashboardReferences

IDashboardReferences.dataSetspropertyAlpha

Alpha API. Initial API, highly likely to change outside SemVer. Don’t build on it in production. See API maturity.

Referenced dataSets. Only direct references, does not include dataSets linked from filter context.

dataSets?: IDataSetMetadataObject[];

IDashboardReferences.insightspropertyAlpha

Alpha API. Initial API, highly likely to change outside SemVer. Don’t build on it in production. See API maturity.

Referenced insights. Empty if no insights on dashboard or referenced insights were not requested.

insights: IInsight[];

IDashboardReferences.pluginspropertyAlpha

Alpha API. Initial API, highly likely to change outside SemVer. Don’t build on it in production. See API maturity.

Referenced plugins. Empty if no plugins on dashboard or referenced plugins were not requested.

plugins: IDashboardPlugin[];

IDashboardReferences.unavailablepropertyAlpha

Alpha API. Initial API, highly likely to change outside SemVer. Don’t build on it in production. See API maturity.

Referenced objects that were requested but could not be returned, each with the reason (see IUnavailableDashboardReference): the current user is not allowed to read the object, or the object no longer exists.

How to use it: for a reference that IS listed, you know why it is missing and can show something better than a generic error (for example a “no access” placeholder). For a reference that is NOT listed, keep doing what you did before this field existed — load the object and handle a failure the usual way. The list is not guaranteed to be complete: when the backend fails while checking one kind of reference, it logs the failure and leaves those references out of the list rather than failing the whole dashboard load.

Undefined means the backend does not perform this check at all; treat it like an empty list.

unavailable?: IUnavailableDashboardReference[];