> ## Documentation Index
> Fetch the complete documentation index at: https://deepline.com/docs/llms.txt
> Use this file to discover all available pages before exploring further.

# ClickHouse Cloud: Clickhouse Click Stack Update Dashboard

> Update a ClickStack dashboard's name, tiles, filters or saved query. Includes SDK V2 guidance, input constraints, response fields, and Deepline credit cost.

Update a ClickStack dashboard's name, tiles, filters or saved query.

> [!NOTE]
>
> Tool ID: `clickhouse_click_stack_update_dashboard`

## Run this action

Use the TypeScript SDK for one call. Use `ctx.tools.execute(...)` inside a Play for durable calls, scheduled calls, or CSV processing.

```ts theme={"languages":{"custom":["/languages/deepline-prompt.json"]}}
import { Deepline } from 'deepline';

const deepline = await Deepline.connect();
const result = await deepline.tools.execute(
  'clickhouse_click_stack_update_dashboard',
  {
    "organizationId": "123e4567-e89b-42d3-a456-426614174000",
    "serviceId": "123e4567-e89b-42d3-a456-426614174000",
    "clickStackDashboardId": "click_stack_dashboard_123",
    "name": "Example",
    "tiles": [
      {
        "name": "Example",
        "x": 123,
        "y": 123,
        "w": 123,
        "h": 123
      }
    ]
  },
);

console.log(result.toolResponse.raw);
```

### CLI

```bash theme={"languages":{"custom":["/languages/deepline-prompt.json"]}}
deepline tools execute clickhouse_click_stack_update_dashboard --input '{
  "organizationId": "123e4567-e89b-42d3-a456-426614174000",
  "serviceId": "123e4567-e89b-42d3-a456-426614174000",
  "clickStackDashboardId": "click_stack_dashboard_123",
  "name": "Example",
  "tiles": [
    {
      "name": "Example",
      "x": 123,
      "y": 123,
      "w": 123,
      "h": 123
    }
  ]
}' --json
```

## Example response

The SDK returns this shape at `result.toolResponse.raw`. The example values illustrate the response.

```json theme={"languages":{"custom":["/languages/deepline-prompt.json"]}}
{
  "data": {
    "status": 123,
    "requestId": "123e4567-e89b-42d3-a456-426614174000",
    "result": {
      "id": "id_123",
      "name": "Example",
      "tiles": [
        {
          "name": "Example",
          "x": 123,
          "y": 123,
          "w": 123,
          "h": 123,
          "id": "id_123"
        }
      ]
    }
  }
}
```

Use `deepline describe clickhouse_click_stack_update_dashboard --json` for the latest machine-readable contract.

## Input reference

**This endpoint is in beta.** API contract is stable, and no breaking changes are expected in the future. ClickStack: Updates an existing dashboard. **Concurrency:** This endpoint does not support optimistic concurrency control. Concurrent PUT requests for the same dashboard may silently overwrite each other, which can leave orphan tile-to-container references on layout-shape edits. Clients should serialize edits to a given dashboard.

| Name | Type | Required | Default | Details |
| - | - | - | - | - |
| `payload.organizationId` | `string` | Yes | — | ID of the organization that owns the service. Format: `uuid`. |
| `payload.serviceId` | `string` | Yes | — | ID of the ClickStack service. Format: `uuid`. |
| `payload.clickStackDashboardId` | `string` | Yes | — | ClickStack Dashboard ID |
| `payload.name` | `string` | Yes | — | Dashboard name. |
| `payload.tiles` | `array` | Yes | — | Full list of tiles for the dashboard. Existing tiles are matched by ID. tiles with an ID that does not match an existing tile will be assigned a new generated ID. |
| `payload.tags` | `array` | No | — | Tags for organizing and filtering dashboards. |
| `payload.filters` | `array` | No | — | Dashboard filter keys on the dashboard, applied across all tiles |
| `payload.savedQuery` | `string` | No | — | Optional default dashboard query to persist on the dashboard. |
| `payload.savedQueryLanguage` | `"sql" \| "lucene"` | No | — | Query language used by savedQuery. Allowed: `sql`, `lucene`. |
| `payload.savedFilterValues` | `array` | No | — | Optional default dashboard filter values to persist on the dashboard. |
| `payload.containers` | `array` | No | — | Optional grouping containers. Each tile may join a container via tile.containerId, and a tab inside it via tile.tabId. |

<details>
  <summary>Show raw input schema</summary>

  ### Input JSON Schema

  ```json theme={"languages":{"custom":["/languages/deepline-prompt.json"]}}
  {
    "type": "object",
    "description": "**This endpoint is in beta.** API contract is stable, and no breaking changes are expected in the future. ClickStack: Updates an existing dashboard. **Concurrency:** This endpoint does not support optimistic concurrency control. Concurrent PUT requests for the same dashboard may silently overwrite each other, which can leave orphan tile-to-container references on layout-shape edits. Clients should serialize edits to a given dashboard.",
    "properties": {
      "organizationId": {
        "type": "string",
        "description": "ID of the organization that owns the service.",
        "format": "uuid"
      },
      "serviceId": {
        "type": "string",
        "description": "ID of the ClickStack service.",
        "format": "uuid"
      },
      "clickStackDashboardId": {
        "type": "string",
        "description": "ClickStack Dashboard ID"
      },
      "name": {
        "type": "string",
        "description": "Dashboard name."
      },
      "tiles": {
        "type": "array",
        "description": "Full list of tiles for the dashboard. Existing tiles are matched by ID; tiles with an ID that does not match an existing tile will be assigned a new generated ID.",
        "items": {
          "properties": {
            "name": {
              "type": "string",
              "description": "Display name for the tile"
            },
            "x": {
              "type": "integer",
              "description": "Horizontal position in the grid (0-based)"
            },
            "y": {
              "type": "integer",
              "description": "Vertical position in the grid (0-based)"
            },
            "w": {
              "type": "integer",
              "description": "Width in grid units"
            },
            "h": {
              "type": "integer",
              "description": "Height in grid units"
            },
            "config": {
              "type": "object",
              "additionalProperties": true
            },
            "containerId": {
              "type": "string",
              "description": "References a DashboardContainer by id. Tiles without containerId render in the default ungrouped area."
            },
            "tabId": {
              "type": "string",
              "description": "References a tab inside the tile's container by id. Requires containerId to be set, and the container to declare a matching tab."
            },
            "id": {
              "type": "string",
              "description": "Optional tile ID. Omit to generate a new ID."
            },
            "asRatio": {
              "type": "boolean",
              "description": "Display two series as a ratio (series[0] / series[1]). Only applicable when providing \"series\". Deprecated in favor of \"config.asRatio\"."
            },
            "series": {
              "type": "array",
              "description": "Data series to display in this tile (all must be the same type). Deprecated; use \"config\" instead.",
              "items": {
                "type": "object",
                "additionalProperties": true
              }
            }
          },
          "required": [
            "name",
            "x",
            "y",
            "w",
            "h"
          ],
          "additionalProperties": false
        }
      },
      "tags": {
        "type": "array",
        "description": "Tags for organizing and filtering dashboards.",
        "items": {
          "type": "string"
        }
      },
      "filters": {
        "type": "array",
        "description": "Dashboard filter keys on the dashboard, applied across all tiles",
        "items": {
          "properties": {
            "type": {
              "type": "string",
              "description": "Filter type. Must be \"QUERY_EXPRESSION\".",
              "enum": [
                "QUERY_EXPRESSION"
              ]
            },
            "name": {
              "type": "string",
              "description": "Display name for the dashboard filter key"
            },
            "expression": {
              "type": "string",
              "description": "Key expression used when applying this dashboard filter key"
            },
            "sourceId": {
              "type": "string",
              "description": "Source ID this dashboard filter key applies to"
            },
            "sourceMetricType": {
              "type": "string",
              "description": "Metric type when source is metrics",
              "enum": [
                "sum",
                "gauge",
                "histogram",
                "summary",
                "exponential histogram"
              ]
            },
            "where": {
              "type": "string",
              "description": "Optional WHERE condition to scope which rows this filter key reads values from"
            },
            "whereLanguage": {
              "type": "string",
              "description": "Language of the where condition",
              "enum": [
                "sql",
                "lucene"
              ]
            },
            "appliesToSourceIds": {
              "type": "array",
              "description": "Optional list of source IDs this filter applies to. Omit or provide an empty array to apply the filter to ALL tiles regardless of source. A non-empty array restricts the filter to only tiles whose source ID is in the list; tiles using other sources are not affected by the selected filter value(s).",
              "items": {
                "type": "string"
              }
            },
            "id": {
              "type": "string",
              "description": "Unique dashboard filter key ID"
            }
          },
          "required": [
            "type",
            "name",
            "expression",
            "sourceId",
            "id"
          ],
          "additionalProperties": false
        }
      },
      "savedQuery": {
        "type": [
          "string",
          "null"
        ],
        "description": "Optional default dashboard query to persist on the dashboard."
      },
      "savedQueryLanguage": {
        "type": [
          "string",
          "null"
        ],
        "description": "Query language used by savedQuery.",
        "enum": [
          "sql",
          "lucene"
        ]
      },
      "savedFilterValues": {
        "type": "array",
        "description": "Optional default dashboard filter values to persist on the dashboard.",
        "items": {
          "properties": {
            "type": {
              "type": "string",
              "description": "Filter type. Currently only \"sql\" is supported.",
              "enum": [
                "sql"
              ]
            },
            "condition": {
              "type": "string",
              "description": "SQL filter condition. For example use expressions in the form \"column IN ('value')\"."
            }
          },
          "required": [
            "condition"
          ],
          "additionalProperties": false
        }
      },
      "containers": {
        "type": "array",
        "description": "Optional grouping containers. Each tile may join a container via tile.containerId, and a tab inside it via tile.tabId.",
        "items": {
          "properties": {
            "id": {
              "type": "string",
              "description": "Unique identifier for the container within the dashboard."
            },
            "title": {
              "type": "string",
              "description": "Display title for the container."
            },
            "collapsed": {
              "type": "boolean",
              "description": "Persisted default collapse state. Per-viewer state lives in the URL."
            },
            "collapsible": {
              "type": "boolean",
              "description": "Whether the user can collapse the group."
            },
            "bordered": {
              "type": "boolean",
              "description": "Whether to show a visual border around the group."
            },
            "tabs": {
              "type": "array",
              "description": "Optional tabs. 2+ entries renders a tab bar; 0-1 entries renders a plain group header. Tiles join a tab via tabId.",
              "items": {
                "properties": {
                  "id": {
                    "type": "string",
                    "description": "Unique identifier for the tab within its container."
                  },
                  "title": {
                    "type": "string",
                    "description": "Display title for the tab."
                  }
                },
                "required": [
                  "id",
                  "title"
                ],
                "additionalProperties": false
              }
            }
          },
          "required": [
            "id",
            "title",
            "collapsed"
          ],
          "additionalProperties": false
        }
      }
    },
    "required": [
      "organizationId",
      "serviceId",
      "clickStackDashboardId",
      "name",
      "tiles"
    ],
    "additionalProperties": false
  }
  ```
</details>

## Output reference

Standard tool result payload.

| Name | Type | Required | Default | Details |
| - | - | - | - | - |
| `result.data` | `object` | Yes | — | Provider response payload. |
| `result.data.status` | `number` | No | — | HTTP status code. |
| `result.data.requestId` | `string` | No | — | Unique id assigned to every request. UUIDv4 Format: `uuid`. |
| `result.data.result` | `object` | No | — | — |
| `result.data.result.id` | `string` | No | — | Dashboard ID |
| `result.data.result.name` | `string` | No | — | Dashboard name |
| `result.data.result.tiles` | `array` | No | — | List of tiles/charts in the dashboard |
| `result.data.result.tiles[].name` | `string` | Yes | — | Display name for the tile |
| `result.data.result.tiles[].x` | `integer` | Yes | — | Horizontal position in the grid (0-based) |
| `result.data.result.tiles[].y` | `integer` | Yes | — | Vertical position in the grid (0-based) |
| `result.data.result.tiles[].w` | `integer` | Yes | — | Width in grid units |
| `result.data.result.tiles[].h` | `integer` | Yes | — | Height in grid units |
| `result.data.result.tiles[].config` | `record` | No | — | — |
| `result.data.result.tiles[].containerId` | `string` | No | — | References a DashboardContainer by id. Tiles without containerId render in the default ungrouped area. |
| `result.data.result.tiles[].tabId` | `string` | No | — | References a tab inside the tile's container by id. Requires containerId to be set, and the container to declare a matching tab. |
| `result.data.result.tiles[].id` | `string` | Yes | — | Unique tile ID assigned by the server. |
| `result.data.result.tags` | `array` | No | — | Tags for organizing and filtering dashboards |
| `result.data.result.filters` | `array` | No | — | Dashboard filter keys added to the dashboard and applied to all tiles |
| `result.data.result.filters[].type` | `"QUERY_EXPRESSION"` | Yes | — | Filter type. Must be "QUERY\_EXPRESSION". Allowed: `QUERY_EXPRESSION`. |
| `result.data.result.filters[].name` | `string` | Yes | — | Display name for the dashboard filter key |
| `result.data.result.filters[].expression` | `string` | Yes | — | Key expression used when applying this dashboard filter key |
| `result.data.result.filters[].sourceId` | `string` | Yes | — | Source ID this dashboard filter key applies to |
| `result.data.result.filters[].sourceMetricType` | `"sum" \| "gauge" \| "histogram" \| "summary" \| "exponential histogram"` | No | — | Metric type when source is metrics Allowed: `sum`, `gauge`, `histogram`, `summary`, `exponential histogram`. |
| `result.data.result.filters[].where` | `string` | No | — | Optional WHERE condition to scope which rows this filter key reads values from |
| `result.data.result.filters[].whereLanguage` | `"sql" \| "lucene"` | No | — | Language of the where condition Allowed: `sql`, `lucene`. |
| `result.data.result.filters[].appliesToSourceIds` | `array` | No | — | Optional list of source IDs this filter applies to. Omit or provide an empty array to apply the filter to ALL tiles regardless of source. A non-empty array restricts the filter to only tiles whose source ID is in the list. tiles using other sources are not affected by the selected filter value(s). |
| `result.data.result.filters[].id` | `string` | Yes | — | Unique dashboard filter key ID |
| `result.data.result.savedQuery` | `string \| null` | No | — | Optional default dashboard query restored when loading the dashboard. |
| `result.data.result.savedQueryLanguage` | `"sql" \| "lucene"` | No | — | Query language used by savedQuery. Allowed: `sql`, `lucene`. |
| `result.data.result.savedFilterValues` | `array` | No | — | Optional default dashboard filter values restored when loading the dashboard. |
| `result.data.result.savedFilterValues[].type` | `"sql"` | No | — | Filter type. Currently only "sql" is supported. Allowed: `sql`. |
| `result.data.result.savedFilterValues[].condition` | `string` | Yes | — | SQL filter condition. For example use expressions in the form "column IN ('value')". |
| `result.data.result.containers` | `array` | No | — | Optional grouping containers. Each tile may join a container via tile.containerId, and a tab inside it via tile.tabId. |
| `result.data.result.containers[].id` | `string` | Yes | — | Unique identifier for the container within the dashboard. |
| `result.data.result.containers[].title` | `string` | Yes | — | Display title for the container. |
| `result.data.result.containers[].collapsed` | `boolean` | Yes | — | Persisted default collapse state. Per-viewer state lives in the URL. |
| `result.data.result.containers[].collapsible` | `boolean` | No | — | Whether the user can collapse the group. |
| `result.data.result.containers[].bordered` | `boolean` | No | — | Whether to show a visual border around the group. |
| `result.data.result.containers[].tabs` | `array` | No | — | Optional tabs. 2+ entries renders a tab bar. 0-1 entries renders a plain group header. Tiles join a tab via tabId. |
| `result.data.result.containers[].tabs[].id` | `string` | Yes | — | Unique identifier for the tab within its container. |
| `result.data.result.containers[].tabs[].title` | `string` | Yes | — | Display title for the tab. |
| `result.meta` | `object` | No | — | Additional response metadata (status, paging). |

<details>
  <summary>Show raw output schema</summary>

  ### Output JSON Schema

  ```json theme={"languages":{"custom":["/languages/deepline-prompt.json"]}}
  {
    "type": "object",
    "description": "Standard tool result payload.",
    "properties": {
      "data": {
        "type": "object",
        "description": "Provider response payload.",
        "properties": {
          "status": {
            "type": "number",
            "description": "HTTP status code."
          },
          "requestId": {
            "type": "string",
            "description": "Unique id assigned to every request. UUIDv4",
            "format": "uuid"
          },
          "result": {
            "properties": {
              "id": {
                "type": "string",
                "description": "Dashboard ID"
              },
              "name": {
                "type": "string",
                "description": "Dashboard name"
              },
              "tiles": {
                "type": "array",
                "description": "List of tiles/charts in the dashboard",
                "items": {
                  "properties": {
                    "name": {
                      "type": "string",
                      "description": "Display name for the tile"
                    },
                    "x": {
                      "type": "integer",
                      "description": "Horizontal position in the grid (0-based)"
                    },
                    "y": {
                      "type": "integer",
                      "description": "Vertical position in the grid (0-based)"
                    },
                    "w": {
                      "type": "integer",
                      "description": "Width in grid units"
                    },
                    "h": {
                      "type": "integer",
                      "description": "Height in grid units"
                    },
                    "config": {
                      "type": "object",
                      "additionalProperties": true
                    },
                    "containerId": {
                      "type": "string",
                      "description": "References a DashboardContainer by id. Tiles without containerId render in the default ungrouped area."
                    },
                    "tabId": {
                      "type": "string",
                      "description": "References a tab inside the tile's container by id. Requires containerId to be set, and the container to declare a matching tab."
                    },
                    "id": {
                      "type": "string",
                      "description": "Unique tile ID assigned by the server."
                    }
                  },
                  "required": [
                    "name",
                    "x",
                    "y",
                    "w",
                    "h",
                    "id"
                  ],
                  "additionalProperties": false
                }
              },
              "tags": {
                "type": "array",
                "description": "Tags for organizing and filtering dashboards",
                "items": {
                  "type": "string"
                }
              },
              "filters": {
                "type": "array",
                "description": "Dashboard filter keys added to the dashboard and applied to all tiles",
                "items": {
                  "properties": {
                    "type": {
                      "type": "string",
                      "description": "Filter type. Must be \"QUERY_EXPRESSION\".",
                      "enum": [
                        "QUERY_EXPRESSION"
                      ]
                    },
                    "name": {
                      "type": "string",
                      "description": "Display name for the dashboard filter key"
                    },
                    "expression": {
                      "type": "string",
                      "description": "Key expression used when applying this dashboard filter key"
                    },
                    "sourceId": {
                      "type": "string",
                      "description": "Source ID this dashboard filter key applies to"
                    },
                    "sourceMetricType": {
                      "type": "string",
                      "description": "Metric type when source is metrics",
                      "enum": [
                        "sum",
                        "gauge",
                        "histogram",
                        "summary",
                        "exponential histogram"
                      ]
                    },
                    "where": {
                      "type": "string",
                      "description": "Optional WHERE condition to scope which rows this filter key reads values from"
                    },
                    "whereLanguage": {
                      "type": "string",
                      "description": "Language of the where condition",
                      "enum": [
                        "sql",
                        "lucene"
                      ]
                    },
                    "appliesToSourceIds": {
                      "type": "array",
                      "description": "Optional list of source IDs this filter applies to. Omit or provide an empty array to apply the filter to ALL tiles regardless of source. A non-empty array restricts the filter to only tiles whose source ID is in the list; tiles using other sources are not affected by the selected filter value(s).",
                      "items": {
                        "type": "string"
                      }
                    },
                    "id": {
                      "type": "string",
                      "description": "Unique dashboard filter key ID"
                    }
                  },
                  "required": [
                    "type",
                    "name",
                    "expression",
                    "sourceId",
                    "id"
                  ],
                  "additionalProperties": false
                }
              },
              "savedQuery": {
                "type": [
                  "string",
                  "null"
                ],
                "description": "Optional default dashboard query restored when loading the dashboard."
              },
              "savedQueryLanguage": {
                "type": [
                  "string",
                  "null"
                ],
                "description": "Query language used by savedQuery.",
                "enum": [
                  "sql",
                  "lucene"
                ]
              },
              "savedFilterValues": {
                "type": "array",
                "description": "Optional default dashboard filter values restored when loading the dashboard.",
                "items": {
                  "properties": {
                    "type": {
                      "type": "string",
                      "description": "Filter type. Currently only \"sql\" is supported.",
                      "enum": [
                        "sql"
                      ]
                    },
                    "condition": {
                      "type": "string",
                      "description": "SQL filter condition. For example use expressions in the form \"column IN ('value')\"."
                    }
                  },
                  "required": [
                    "condition"
                  ],
                  "additionalProperties": false
                }
              },
              "containers": {
                "type": "array",
                "description": "Optional grouping containers. Each tile may join a container via tile.containerId, and a tab inside it via tile.tabId.",
                "items": {
                  "properties": {
                    "id": {
                      "type": "string",
                      "description": "Unique identifier for the container within the dashboard."
                    },
                    "title": {
                      "type": "string",
                      "description": "Display title for the container."
                    },
                    "collapsed": {
                      "type": "boolean",
                      "description": "Persisted default collapse state. Per-viewer state lives in the URL."
                    },
                    "collapsible": {
                      "type": "boolean",
                      "description": "Whether the user can collapse the group."
                    },
                    "bordered": {
                      "type": "boolean",
                      "description": "Whether to show a visual border around the group."
                    },
                    "tabs": {
                      "type": "array",
                      "description": "Optional tabs. 2+ entries renders a tab bar; 0-1 entries renders a plain group header. Tiles join a tab via tabId.",
                      "items": {
                        "properties": {
                          "id": {
                            "type": "string",
                            "description": "Unique identifier for the tab within its container."
                          },
                          "title": {
                            "type": "string",
                            "description": "Display title for the tab."
                          }
                        },
                        "required": [
                          "id",
                          "title"
                        ],
                        "additionalProperties": false
                      }
                    }
                  },
                  "required": [
                    "id",
                    "title",
                    "collapsed"
                  ],
                  "additionalProperties": false
                }
              }
            },
            "additionalProperties": false
          }
        },
        "additionalProperties": false
      },
      "meta": {
        "type": "object",
        "description": "Additional response metadata (status, paging).",
        "additionalProperties": true
      }
    },
    "required": [
      "data"
    ],
    "additionalProperties": false
  }
  ```
</details>

## Deepline cost

* Pricing model: `fixed` (per call).
* Estimated Deepline credits: `0` per pricing unit.
* Provider-native pricing may still exist outside Deepline credit billing.

## Related documentation

* [ClickHouse Cloud provider guide](https://deepline.com/docs/providers/clickhouse/guide.md)
* [SDK V2 quickstart](https://deepline.com/docs/sdk-v2/quickstart.md)
* [SDK reference](https://deepline.com/docs/sdk-v2/sdk-reference.md)
* [Run tools across a CSV](https://deepline.com/docs/sdk-v2/batch-csv.md)


This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.