> ## 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 Click Stack Get Dashboard: Inputs, Cost & CLI
> ClickStack: Get Dashboard. Clickhouse Clickhouse Click Stack Get Dashboard docs include request fields, response shape, pricing notes, and Deepline CLI
## Run in Enrichment Spreadsheet
Use this function as a column step in `deepline enrich`.
```bash theme={null}
deepline enrich --input leads.csv --output leads.enriched.csv --with 'result=clickhouse_click_stack_get_dashboard:{"organizationId":"{{organizationId}}","serviceId":"{{serviceId}}","clickStackDashboardId":"{{clickStackDashboardId}}"}' --json
```
Map payload values to spreadsheet columns with `{{column_name}}` placeholders.
## Input Schema
| Name | Type | Required | Default | Description |
| ------------------------------- | -------- | -------- | ------- | --------------------------------------------- |
| `payload.organizationId` | `string` | Yes | | ID of the organization that owns the service. |
| `payload.serviceId` | `string` | Yes | | ID of the ClickStack service. |
| `payload.clickStackDashboardId` | `string` | Yes | | ClickStack Dashboard ID |
Show raw input schema
### Input JSON Schema
```json theme={null}
{
"type": "object",
"description": "**This endpoint is in beta.** API contract is stable, and no breaking changes are expected in the future. ClickStack: Retrieves a specific dashboard by ID",
"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"
}
},
"required": [
"organizationId",
"serviceId",
"clickStackDashboardId"
],
"additionalProperties": false
}
```
## Output Schema
| Name | Type | Required | Default | Description |
| ------------- | -------- | -------- | ------- | ---------------------------------------------- |
| `result.data` | `object` | Yes | | Provider response payload. |
| `result.meta` | `object` | No | | Additional response metadata (status, paging). |
Show raw output schema
### Output JSON Schema
```json theme={null}
{
"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
}
```
## Advanced: Direct CLI
Use direct execution for single payload debugging.
```bash theme={null}
deepline tools execute clickhouse_click_stack_get_dashboard --payload '{
"organizationId": "string",
"serviceId": "string",
"clickStackDashboardId": "string"
}' --json
```
### CLI flags
| Flag | Description |
| --------------------------- | --------------------------------------------------- |
| `--json` | Print machine-readable output. |
| `--wait` | Wait for terminal provider status when supported. |
| `--debug` | Enable wait mode with additional status/log output. |
| `--wait-timeout SECONDS` | Max seconds to wait in wait mode. |
| `--poll-interval SECONDS` | Polling interval in seconds during wait mode. |
| `--timeout SECONDS` | Request timeout in seconds. |
| `--connect-timeout SECONDS` | Connection timeout in seconds. |
## Cost
* Pricing model: `fixed` (per call).
* Estimated Deepline credits: `0` per pricing unit.
* Provider-native pricing may still exist outside Deepline credit billing.
* Billing mode: `no_bill`.