ClickHouse Cloud: Clickhouse Click Stack List Dashboards

ClickStack: List Dashboards.

Tool ID: clickhouse_click_stack_list_dashboards

Run this action

Use the TypeScript SDK for a single call. Put ctx.tools.execute(...) inside a Play when the call should be durable, scheduled, or run across a CSV.

import { Deepline } from 'deepline';

const deepline = await Deepline.connect();
const result = await deepline.tools.execute(
  'clickhouse_click_stack_list_dashboards',
  {
    "organizationId": "123e4567-e89b-42d3-a456-426614174000",
    "serviceId": "123e4567-e89b-42d3-a456-426614174000"
  },
);

console.log(result.toolResponse.raw);

CLI

deepline tools execute clickhouse_click_stack_list_dashboards --input '{
  "organizationId": "123e4567-e89b-42d3-a456-426614174000",
  "serviceId": "123e4567-e89b-42d3-a456-426614174000"
}' --json

Example response

The SDK exposes this shape at result.toolResponse.raw. Values below are representative.

{
  "data": {
    "status": 123,
    "requestId": "123e4567-e89b-42d3-a456-426614174000",
    "result": [
      {
        "id": "id_123",
        "name": "Example"
      }
    ]
  }
}

Use deepline tools get clickhouse_click_stack_list_dashboards --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: Retrieves a list of all dashboards for the authenticated team

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`.

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`	`array`	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).

Deepline cost

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

Get started

Build and automate

Common workflows

Data and integrations

Reference

ClickHouse Cloud: Clickhouse Click Stack List Dashboards

Run this action

CLI

Example response

Input reference

Output reference

Deepline cost

​Run this action

​CLI

​Example response

​Input reference

​Output reference

​Deepline cost

​Related documentation

Run this action

CLI

Example response

Input reference

Output reference

Deepline cost

Related documentation