> ## 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 Query Run Get: Inputs, Cost & CLI Example

> Run a saved ClickHouse query endpoint with URL parameters. Includes inputs, outputs, pricing notes, Deepline CLI examples, and GTM automation guidance.

## Run in Enrichment Spreadsheet

<Info>
  Use this function as a column step in `deepline enrich`.
</Info>

```bash theme={null}
deepline enrich --input leads.csv --output leads.enriched.csv --with 'result=clickhouse_query_endpoint_run_get:{"queryEndpointId":"{{queryEndpointId}}"}' --json
```

<Tip>
  Map payload values to spreadsheet columns with `{{column_name}}` placeholders.
</Tip>

## Input Schema

| Name                      | Type      | Required | Default | Description                                                                                           |
| ------------------------- | --------- | -------- | ------- | ----------------------------------------------------------------------------------------------------- |
| `payload.queryEndpointId` | `string`  | Yes      |         | The unique identifier of the saved Query Endpoint to run.                                             |
| `payload.format`          | `string`  | No       |         | ClickHouse response format, such as JSONEachRow.                                                      |
| `payload.request_timeout` | `integer` | No       |         | Query timeout in milliseconds.                                                                        |
| `payload.queryVariables`  | `record`  | No       |         | Simple scalar query variables. Deepline serializes each value as ClickHouse's URL parameter param\_ . |
| `payload.endpointVersion` | `1 \| 2`  | No       | `2`     | Query Endpoint version sent in the x-clickhouse-endpoint-version header.                              |

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

  ### Input JSON Schema

  ```json theme={null}
  {
    "type": "object",
    "description": "Executes a saved Query Endpoint. Use this for simple scalar query variables. This action runs the SQL saved in ClickHouse; it can modify data when that saved endpoint has write permissions.",
    "properties": {
      "queryEndpointId": {
        "type": "string",
        "description": "The unique identifier of the saved Query Endpoint to run.",
        "minLength": 1
      },
      "format": {
        "type": "string",
        "description": "ClickHouse response format, such as JSONEachRow."
      },
      "request_timeout": {
        "type": "integer",
        "description": "Query timeout in milliseconds.",
        "minimum": 1
      },
      "queryVariables": {
        "type": "object",
        "description": "Simple scalar query variables. Deepline serializes each value as ClickHouse's URL parameter param_ .",
        "additionalProperties": {
          "type": [
            "string",
            "number",
            "boolean"
          ]
        }
      },
      "endpointVersion": {
        "type": "integer",
        "description": "Query Endpoint version sent in the x-clickhouse-endpoint-version header.",
        "default": 2,
        "enum": [
          1,
          2
        ]
      }
    },
    "required": [
      "queryEndpointId"
    ],
    "additionalProperties": false
  }
  ```
</details>

## Output Schema

| Name          | Type      | Required | Default | Description                                    |
| ------------- | --------- | -------- | ------- | ---------------------------------------------- |
| `result.data` | `unknown` | Yes      |         | Provider response payload.                     |
| `result.meta` | `object`  | No       |         | Additional response metadata (status, paging). |

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

  ### Output JSON Schema

  ```json theme={null}
  {
    "type": "object",
    "description": "Standard tool result payload.",
    "properties": {
      "data": {
        "description": "Provider response payload."
      },
      "meta": {
        "type": "object",
        "description": "Additional response metadata (status, paging).",
        "additionalProperties": true
      }
    },
    "required": [
      "data"
    ],
    "additionalProperties": false
  }
  ```
</details>

## Advanced: Direct CLI

<Info>
  Use direct execution for single payload debugging.
</Info>

```bash theme={null}
deepline tools execute clickhouse_query_endpoint_run_get --payload '{
  "queryEndpointId": "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`.