Skip to main content

Documentation index: llms.txt. This page is also available as markdown: append .md to this URL or send Accept: text/markdown.

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 general​

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 general​

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 general​

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 general​

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 general​

The dashboard belongs to this data source

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

The tag entities belonging to this dashboard

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

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 general​

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​

{
  "entityEditors": [
    {
      "sourceUser": {
        "unifiedUser": {
          "teamIds": []
        }
      }
    }
  ],
  "ownerEntities": [
    {
      "ownerLabel": {},
      "user": {
        "ownerEntities": []
      }
    }
  ],
  "source": {},
  "tagEntities": [
    {
      "tag": {}
    }
  ],
  "teamOwnerEntities": [
    {
      "team": {
        "teamOwnerEntities": []
      }
    }
  ]
}

Member Of​