ONoneuptime
BI Dashboard

Get BI Dashboard

Endpoint to retrieve a single BI Dashboard by ID

post/data-dashboard/{id}/get-item

Request

Path parameters

idstring uuid required

ID of the BI Dashboard to retrieve

Request body

Example request

{
  "select": {
    "_id": true,
    "createdAt": true,
    "updatedAt": true,
    "tool": true,
    "externalId": true,
    "owner": true
  }
}

Response

Successful response

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.