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.

GetCommentsOutput

Paginated response from the executed query or mutation

type GetCommentsOutput {
  greatestId: String
  nbPerPage: Int!
  page: Int
  totalCount: Int!
  data: [Comment!]!
}

Fields​

GetCommentsOutput.greatestId ● String scalar general​

The greatest id returned, to pass as the next 'greaterThanId' when using cursor-based pagination. Returned only when page is not used.

GetCommentsOutput.nbPerPage ● Int! non-null scalar general​

Number of entities to return per page

GetCommentsOutput.page ● Int scalar general​

The page number (start at 0). Returned only when greaterThanId is not used.

GetCommentsOutput.totalCount ● Int! non-null scalar general​

The total number of entities

GetCommentsOutput.data ● [Comment!]! non-null object comments​

Field containing the response from the executed query or mutation

Example​

{
  "greatestId": "fffe43cb-a92f-48d9-9527-3fcc4e5f6dba",
  "nbPerPage": 50,
  "page": 0,
  "totalCount": 100,
  "data": [
    {
      "id": "fffe43cb-a92f-48d9-9527-3fcc4e5f6dba",
      "authoredByService": "SLACK",
      "message": "Which of these columns should I use to count our **customers**?",
      "origin": "REGULAR",
      "authorId": "fffe43cb-a92f-48d9-9527-3fcc4e5f6dba",
      "author": {
        "avatarUrl": "https://example.com/avatar.png",
        "email": "john.doe@example.com",
        "externalId": "fffe43cb-a92f-48d9-9527-3fcc4e5f6dba",
        "firstName": "John",
        "lastName": "Doe",
        "role": "CONTRIBUTOR",
        "status": "ACTIVATED",
        "ownerEntities": [
          {
            "dashboardId": "fffe43cb-a92f-48d9-9527-3fcc4e5f6dba",
            "ownerLabelId": "fffe43cb-a92f-48d9-9527-3fcc4e5f6dba",
            "ownerLabel": {
              "label": "Data Steward"
            },
            "tableId": "fffe43cb-a92f-48d9-9527-3fcc4e5f6dba",
            "termId": "fffe43cb-a92f-48d9-9527-3fcc4e5f6dba",
            "unifiedUser": {
              "name": "John Doe",
              "teamIds": [
                "fffe43cb-a92f-48d9-9527-3fcc4e5f6dba"
              ],
              "userId": "fffe43cb-a92f-48d9-9527-3fcc4e5f6dba",
              "createdAt": 1758555879800
            },
            "updatedAt": 1758555879800
          }
        ],
        "fullName": "John Doe"
      },
      "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,
        "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": [
          {
            "sourceUserId": "fffe43cb-a92f-48d9-9527-3fcc4e5f6dba",
            "sourceUser": {
              "sourceId": "fffe43cb-a92f-48d9-9527-3fcc4e5f6dba",
              "unifiedId": "fffe43cb-a92f-48d9-9527-3fcc4e5f6dba",
              "deletedAt": 1758555879800
            },
            "refreshedAt": 1758555879800
          }
        ],
        "lastDescribedByUserId": "fffe43cb-a92f-48d9-9527-3fcc4e5f6dba",
        "ownerEntities": [],
        "source": {
          "lastRefreshedAt": 1758555879800,
          "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
      },
      "table": {
        "lastQueriedAt": 1758555879800,
        "numberOfQueries": 100,
        "tableSize": 32,
        "tableType": "TABLE",
        "transformationSource": "COALESCE",
        "entityEditors": [],
        "externalLinks": [
          {}
        ],
        "ownerEntities": [],
        "schemaId": "fffe43cb-a92f-48d9-9527-3fcc4e5f6dba",
        "schema": {
          "isHidden": false,
          "databaseId": "fffe43cb-a92f-48d9-9527-3fcc4e5f6dba",
          "database": {}
        },
        "tagEntities": [],
        "teamOwnerEntities": []
      },
      "term": {
        "depthLevel": 0,
        "icon": "🤖",
        "lastEditedAt": 1758555879800,
        "childrenTerms": [],
        "entityEditors": [],
        "ownerEntities": [],
        "parentTermId": "fffe43cb-a92f-48d9-9527-3fcc4e5f6dba",
        "tagEntities": [],
        "teamOwnerEntities": []
      }
    }
  ]
}

Returned By​