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.

DashboardField

A dashboard field represents a single field within a dashboard. Each dashboard field is linked to a dashboard and contains metadata such as data type, description, and technical identifier.

type DashboardField {
  id: ID!
  dataType: String!
  description: String
  externalId: String!
  isPrimaryKey: Boolean
  label: String!
  name: String!
  popularity: Int
  slug: String!
  viewLabel: String
  viewName: String
  dashboardId: String!
  dashboard: Dashboard!
  createdAt: Timestamp!
  deletedAt: Timestamp
  updatedAt: Timestamp!
}

Fields​

DashboardField.id ● ID! non-null scalar general​

Unique identifier

DashboardField.dataType ● String! non-null scalar general​

The data type for the dashboard field

DashboardField.description ● String scalar general​

The Catalog documentation for this column

DashboardField.externalId ● String! non-null scalar general​

The technical identifier within the source

DashboardField.isPrimaryKey ● Boolean scalar general​

True if this field is a primary key

DashboardField.label ● String! non-null scalar general​

The dashboard field label

DashboardField.name ● String! non-null scalar general​

The dashboard field name

DashboardField.popularity ● Int scalar general​

Field popularity

DashboardField.slug ● String! non-null scalar general​

The dashboard field slug

DashboardField.viewLabel ● String scalar general​

Name of the view used for display

DashboardField.viewName ● String scalar general​

Technical name of the view

DashboardField.dashboardId ● String! non-null scalar general​

Id of the dashboard this field belongs to

DashboardField.dashboard ● Dashboard! non-null object general​

The field belongs to this dashboard

DashboardField.createdAt ● Timestamp! non-null scalar general​

Timestamp of when the record was created

DashboardField.deletedAt ● Timestamp scalar general​

Timestamp of when the record was soft-deleted

DashboardField.updatedAt ● Timestamp! non-null scalar general​

Timestamp of when the record was last updated

Example​

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

Member Of​