Dashboard

A dashboard represents a collection of visualizations and reports, providing insights into data. Each dashboard contains metadata, documentation, and links to its source and related entities.

type Dashboard {
  id: ID!
  deprecatedAt: Timestamp
  descriptionRaw: String
  descriptionStateLexical: JSON
  externalDescription: String
  externalDescriptionSource: DashboardExternalDescriptionSource
  externalId: String!
  externalSlug: String
  folderPath: String!
  folderUrl: String
  isDescriptionGenerated: Boolean
  name: String!
  popularity: Int
  slug: String!
  type: DashboardType!
  url: String!
  verifiedAt: Timestamp
  deprecatedByUserId: String
  entityEditors: [EntityEditor!]!
  lastDescribedByUserId: String
  ownerEntities: [OwnerEntity!]!
  sourceId: String!
  source: Source!
  tagEntities: [TagEntity!]!
  teamOwnerEntities: [TeamOwnerEntity!]!
  verifiedByUserId: String
  verifiedBy: User
  createdAt: Timestamp!
  deletedAt: Timestamp
  updatedAt: Timestamp!
  description: String!
  isDeprecated: Boolean!
  isVerified: Boolean!
}

Fields

Dashboard.id ● ID! non-null scalar general

Unique Catalog identifier of the resource

Dashboard.deprecatedAt ● Timestamp scalar general

The time at which the dashboard was deprecated

Dashboard.descriptionRaw ● String scalar general

The Catalog documentation for this dashboard, as raw text. Can contains Markdown.

Dashboard.descriptionStateLexical ● JSON scalar general

Rich-text description of this dashboard as lexical JSON

Dashboard.externalDescription ● String scalar general

The documentation from the source for this dashboard

Dashboard.externalDescriptionSource ● DashboardExternalDescriptionSource enum dashboards

The source of the documentation for this dashboard

Dashboard.externalId ● String! non-null scalar general

The external ID of the dashboard

Dashboard.externalSlug ● String scalar general

The external slug of the dashboard

Dashboard.folderPath ● String! non-null scalar general

The folder path inside the external data source. Format is root/folder1/folder2

Dashboard.folderUrl ● String scalar general

The url of the folder where the dashboard lies in the source

Dashboard.isDescriptionGenerated ● Boolean scalar general

True if the description has been generated, false otherwise

Dashboard.name ● String! non-null scalar general

The dashboard name

Dashboard.popularity ● Int scalar general

·The dashboard popularity rated out of 1000000

Dashboard.slug ● String! non-null scalar general

Unique Catalog slug of the resource

Dashboard.type ● DashboardType! non-null enum dashboards

The dashboard's type

Dashboard.url ● String! non-null scalar general

The dashboard url in the source

Dashboard.verifiedAt ● Timestamp scalar general

The time at which the dashboard was verified

Dashboard.deprecatedByUserId ● String scalar general

The dashboard was deprecated by the user belonging to this ID

Dashboard.entityEditors ● [EntityEditor!]! non-null object users

The editors associated to this dashboard

Dashboard.lastDescribedByUserId ● String scalar general

The dashboard was last described be the user belonging to this ID

Dashboard.ownerEntities ● [OwnerEntity!]! non-null object ownerships

The individual owners of the dashboard

Dashboard.sourceId ● String! non-null scalar general

The dashboard belongs to this data source ID

Dashboard.source ● Source! non-null object sources

The dashboard belongs to this data source

Dashboard.tagEntities ● [TagEntity!]! non-null object tags

The tag entities belonging to this dashboard

Dashboard.teamOwnerEntities ● [TeamOwnerEntity!]! non-null object ownerships

The team owners of the dashboard

Dashboard.verifiedByUserId ● String scalar general

The dashboard is verified by the user belonging to this ID

Dashboard.verifiedBy ● User object users

The dashboard is verified by this user

Dashboard.createdAt ● Timestamp! non-null scalar general

Timestamp of when the record was created

Dashboard.deletedAt ● Timestamp scalar general

Timestamp of when the record was soft-deleted

Dashboard.updatedAt ● Timestamp! non-null scalar general

Timestamp of when the record was last updated

Dashboard.description ● String! non-null scalar general

The dashboard custom rawDescription or the external one if empty

Dashboard.isDeprecated ● Boolean! non-null scalar general

Whether this dashboard has been marked as deprecated

Dashboard.isVerified ● Boolean! non-null scalar general

Whether this dashboard has been marked as verified

Example

{
  "id": "fffe43cb-a92f-48d9-9527-3fcc4e5f6dba",
  "deprecatedAt": 1758555879800,
  "descriptionRaw": "Sales evolution per ***customers**",
  "descriptionStateLexical": {
    "root": {
      "children": [
        {
          "type": "paragraph",
          "version": 1
        }
      ],
      "direction": null,
      "format": "",
      "indent": 0,
      "type": "root",
      "version": 1
    }
  },
  "externalDescription": "Sales evolution per customers",
  "externalDescriptionSource": "VISUALIZATION",
  "externalId": "dashboard-sales-by-customers",
  "externalSlug": "dashboard-sales-by-customers",
  "folderPath": "product/sales/france",
  "folderUrl": "https://example.com/product/sales/france",
  "isDescriptionGenerated": false,
  "name": "Sales evolution per customers",
  "popularity": 80,
  "slug": "dashboard-sales-by-customers",
  "type": "VIZ_MODEL",
  "url": "https://example.com/product/sales/france/sales-evolution-per-customers",
  "verifiedAt": 1758555879800,
  "deprecatedByUserId": "fffe43cb-a92f-48d9-9527-3fcc4e5f6dba",
  "entityEditors": [
    {
      "dashboardId": "fffe43cb-a92f-48d9-9527-3fcc4e5f6dba",
      "sourceUserId": "fffe43cb-a92f-48d9-9527-3fcc4e5f6dba",
      "sourceUser": {
        "avatarUrl": "https://example.com/avatar.png",
        "email": "john.doe@example.com",
        "sourceId": "fffe43cb-a92f-48d9-9527-3fcc4e5f6dba",
        "unifiedId": "fffe43cb-a92f-48d9-9527-3fcc4e5f6dba",
        "unifiedUser": {
          "role": "CONTRIBUTOR",
          "status": "ACTIVATED",
          "teamIds": [
            "fffe43cb-a92f-48d9-9527-3fcc4e5f6dba"
          ],
          "userId": "fffe43cb-a92f-48d9-9527-3fcc4e5f6dba",
          "createdAt": 1758555879800
        },
        "deletedAt": 1758555879800,
        "updatedAt": 1758555879800
      },
      "tableId": "fffe43cb-a92f-48d9-9527-3fcc4e5f6dba",
      "termId": "fffe43cb-a92f-48d9-9527-3fcc4e5f6dba",
      "refreshedAt": 1758555879800
    }
  ],
  "lastDescribedByUserId": "fffe43cb-a92f-48d9-9527-3fcc4e5f6dba",
  "ownerEntities": [
    {
      "ownerLabelId": "fffe43cb-a92f-48d9-9527-3fcc4e5f6dba",
      "ownerLabel": {
        "label": "Data Steward"
      },
      "user": {
        "firstName": "John",
        "lastName": "Doe",
        "ownerEntities": [],
        "fullName": "John Doe"
      }
    }
  ],
  "source": {
    "lastRefreshedAt": 1758555879800,
    "origin": "EXTRACTION",
    "technology": "SNOWFLAKE"
  },
  "tagEntities": [
    {
      "tagId": "fffe43cb-a92f-48d9-9527-3fcc4e5f6dba",
      "tag": {
        "color": "ALERT_COLOR",
        "linkedTermId": "fffe43cb-a92f-48d9-9527-3fcc4e5f6dba"
      }
    }
  ],
  "teamOwnerEntities": [
    {
      "teamId": "fffe43cb-a92f-48d9-9527-3fcc4e5f6dba",
      "team": {
        "description": "Members of the EMEA sales team",
        "slackChannel": "#emea-sales",
        "slackGroup": "@emea-sales",
        "source": "Slack",
        "teamOwnerEntities": []
      }
    }
  ],
  "verifiedByUserId": "fffe43cb-a92f-48d9-9527-3fcc4e5f6dba",
  "isDeprecated": false,
  "isVerified": false
}

Member Of

• Comment object
• DashboardField object
• DataProduct object
• EntitiesLink object
• GetDashboardsOutput object