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
  role: DashboardFieldRole!
  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.role ● DashboardFieldRole! non-null enum dashboard-fields​

The data role for the column

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

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​

{
  "id": "fffe43cb-a92f-48d9-9527-3fcc4e5f6dba",
  "dataType": "STRING",
  "description": "Contains customer email",
  "externalId": "sales-by-customers",
  "isPrimaryKey": true,
  "label": "Lifetime Revenue",
  "name": "lifetime_revenue",
  "popularity": 100,
  "role": "MEASURE",
  "slug": "sales-by-customers-325e7e1a",
  "viewLabel": "user_order_facts",
  "viewName": "user_order_facts",
  "dashboardId": "fffe43cb-a92f-48d9-9527-3fcc4e5f6dba",
  "dashboard": {
    "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",
    "externalSlug": "dashboard-sales-by-customers",
    "folderPath": "product/sales/france",
    "folderUrl": "https://example.com/product/sales/france",
    "isDescriptionGenerated": false,
    "type": "VIZ_MODEL",
    "url": "https://example.com/product/sales/france/sales-evolution-per-customers",
    "verifiedAt": 1758555879800,
    "deprecatedByUserId": "fffe43cb-a92f-48d9-9527-3fcc4e5f6dba",
    "entityEditors": [
      {
        "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": {
            "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": {},
        "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": {
          "slackChannel": "#emea-sales",
          "slackGroup": "@emea-sales",
          "source": "Slack",
          "teamOwnerEntities": []
        }
      }
    ],
    "verifiedByUserId": "fffe43cb-a92f-48d9-9527-3fcc4e5f6dba",
    "isDeprecated": false,
    "isVerified": false
  }
}

Member Of​