ONoneuptime
BI Dashboard

List BI Dashboard

Endpoint to list all BI Dashboard items

post/data-dashboard/get-list

Request

Request body

limitnumber

Maximum number of items to return. Defaults to 10.

skipnumber

Number of items to skip for pagination. Defaults to 0.

Example request

{
  "query": {
    "createdAt": {
      "_type": "GreaterThan",
      "value": "2026-01-01T00:00:00.000Z"
    },
    "tool": {
      "_type": "Search",
      "value": "example"
    }
  },
  "select": {
    "_id": true,
    "createdAt": true,
    "updatedAt": true,
    "tool": true,
    "externalId": true,
    "owner": true
  },
  "sort": {
    "createdAt": "DESC"
  }
}

Response

Successful response

countnumber

Example response

{
  "data": [
    {
      "_id": "123e4567-e89b-12d3-a456-426614174000",
      "createdAt": {
        "_type": "DateTime",
        "value": "2023-10-01T12:00:00Z"
      },
      "updatedAt": {
        "_type": "DateTime",
        "value": "2023-10-01T12:00:00Z"
      },
      "deletedAt": {
        "_type": "DateTime",
        "value": "2023-10-01T12:00:00Z"
      },
      "version": 42,
      "projectId": "123e4567-e89b-12d3-a456-426614174000",
      "dataBiConnectionId": "123e4567-e89b-12d3-a456-426614174000",
      "tool": "Metabase",
      "externalId": "42",
      "name": "Revenue by region",
      "url": "https://metabase.acme.com/dashboard/42",
      "folder": "Finance",
      "owner": "Ana Lima",
      "changedAt": {
        "_type": "DateTime",
        "value": "2023-10-01T12:00:00Z"
      },
      "tableCount": 42,
      "dataAssets": [
        {
          "_id": "aaaaaaaa-aaaa-aaaa-aaaa-aaaaaaaaaaaa"
        }
      ],
      "createdByUserId": "123e4567-e89b-12d3-a456-426614174000"
    }
  ]
}

Changes

No recorded changes to this operation across all 1 revision of this API.