PATCH
/
dashboards
/
{dashboard_id}
{
  "name": "<string>",
  "description": "<string>",
  "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "created_at": "2023-11-07T05:31:56Z",
  "organisation_id": "<string>",
  "datasets": [
    {
      "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "name": "<string>",
      "description": "<string>",
      "detailed_description": "<string>",
      "organisation_id": "<string>",
      "dictionary": {},
      "status": "<string>",
      "starred": true,
      "dataset_schema": {
        "column_schemas": {}
      },
      "annotations": {},
      "created_at": "2023-11-07T05:31:56Z",
      "updated_at": "2023-11-07T05:31:56Z",
      "columns": [
        "<string>"
      ],
      "is_embedding_searchable": true
    }
  ],
  "elements": [
    {
      "name": "<string>",
      "type": "STANDARD_TABLE",
      "config": {
        "type": "<string>",
        "columns": [
          "<string>"
        ],
        "similarity_score_column": false
      },
      "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "created_at": "2023-11-07T05:31:56Z",
      "dataset": {
        "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
        "name": "<string>",
        "description": "<string>",
        "detailed_description": "<string>",
        "organisation_id": "<string>",
        "dictionary": {},
        "status": "<string>",
        "starred": true,
        "dataset_schema": {
          "column_schemas": {}
        },
        "annotations": {},
        "created_at": "2023-11-07T05:31:56Z",
        "updated_at": "2023-11-07T05:31:56Z",
        "columns": [
          "<string>"
        ],
        "is_embedding_searchable": true
      },
      "position": 123,
      "width": 123
    }
  ],
  "filters": [
    {
      "column": "<string>",
      "filter_type": "CONTAINS",
      "value": "<string>",
      "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "dataset": {
        "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
        "name": "<string>",
        "description": "<string>",
        "detailed_description": "<string>",
        "organisation_id": "<string>",
        "dictionary": {},
        "status": "<string>",
        "starred": true,
        "dataset_schema": {
          "column_schemas": {}
        },
        "annotations": {},
        "created_at": "2023-11-07T05:31:56Z",
        "updated_at": "2023-11-07T05:31:56Z",
        "columns": [
          "<string>"
        ],
        "is_embedding_searchable": true
      }
    }
  ],
  "embedding_searches": [
    {
      "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "sentence": "<string>",
      "created_at": "2023-11-07T05:31:56Z"
    }
  ]
}

Authorizations

​
Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Headers

​
Current-Org-Id
string | null

Represents the current organisation ID for the user (example: 'org_u13TesTDumMyEe5P')

​
Api-key
string | null

Path Parameters

​
dashboard_id
string
required

Body

application/json

Response

200
application/json

Successful Response

The response is of type object.