> ## 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 Pipe Get List: Inputs, Cost & CLI Example
> List ClickPipes. Clickhouse Clickhouse Click Pipe Get List docs include request fields, response shape, pricing notes, and Deepline CLI examples.
## 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_pipe_get_list:{"organizationId":"{{organizationId}}","serviceId":"{{serviceId}}"}' --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 service that owns the ClickPipe. |
Show raw input schema
### Input JSON Schema
```json theme={null}
{
"type": "object",
"description": "Returns a list of ClickPipes.",
"properties": {
"organizationId": {
"type": "string",
"description": "ID of the organization that owns the service.",
"format": "uuid"
},
"serviceId": {
"type": "string",
"description": "ID of the service that owns the ClickPipe.",
"format": "uuid"
}
},
"required": [
"organizationId",
"serviceId"
],
"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": {
"type": "array",
"items": {
"properties": {
"id": {
"type": "string",
"description": "Unique ClickPipe ID.",
"format": "uuid"
},
"serviceId": {
"type": "string",
"description": "ID of the service this ClickPipe belongs to.",
"format": "uuid"
},
"name": {
"type": "string",
"description": "Name of the ClickPipe.",
"minLength": 1,
"maxLength": 255
},
"state": {
"type": "string",
"description": "Current lifecycle state of the ClickPipe. For database pipes: \"Provisioning\" (initial setup), \"Setup\" (configuring replication), \"Snapshot\" (initial data load), \"Running\" (actively replicating), \"Pausing\" (transitioning to paused state), \"Paused\" (temporarily paused), \"Modifying\" (applying configuration updates), \"Resync\" (swapping resync tables with original tables), \"Failed\" (error occurred), \"Unknown\". For streaming/object storage pipes (Kafka, Kinesis, S3): \"Unknown\" (initial state), \"Provisioning\" (setting up resources), \"Running\" (actively ingesting data), \"Stopping\" (transitioning to stopped state), \"Stopped\" (manually stopped, can be restarted), \"Completed\" (batch ingestion finished for object storage), \"Failed\" (error occurred, pipe stopped), \"InternalError\" (internal system error).",
"enum": [
"Unknown",
"Provisioning",
"Running",
"Stopping",
"Stopped",
"Failed",
"Completed",
"InternalError",
"Setup",
"Snapshot",
"Paused",
"Pausing",
"Modifying",
"Resync"
]
},
"scaling": {
"properties": {
"replicas": {
"type": "integer",
"description": "Desired number of replicas. Only for scalable pipes.",
"minimum": 1,
"maximum": 40
},
"concurrency": {
"type": "integer",
"description": "Desired number of concurrency. Only for S3 pipes. If set to 0, concurrency is auto-scaled based on the cluster memory."
},
"replicaCpuMillicores": {
"type": "integer",
"description": "CPU in millicores for each replica. Only for streaming pipes.",
"minimum": 125,
"maximum": 2000
},
"replicaMemoryGb": {
"type": "number",
"description": "Memory in GB for each replica. Only for streaming pipes.",
"minimum": 0.5,
"maximum": 8
}
},
"additionalProperties": false
},
"source": {
"properties": {
"kafka": {
"type": "object",
"additionalProperties": true
},
"objectStorage": {
"type": "object",
"additionalProperties": true
},
"kinesis": {
"type": "object",
"additionalProperties": true
},
"pubsub": {
"type": "object",
"additionalProperties": true
},
"postgres": {
"type": "object",
"additionalProperties": true
},
"mysql": {
"type": "object",
"additionalProperties": true
},
"bigquery": {
"type": "object",
"additionalProperties": true
},
"mongodb": {
"type": "object",
"additionalProperties": true
}
},
"additionalProperties": false
},
"destination": {
"properties": {
"database": {
"type": "string",
"description": "Destination database."
},
"table": {
"type": "string",
"description": "Destination table. Required field for all pipe types except database pipes (Postgres, MySQL, BigQuery)."
},
"managedTable": {
"type": "boolean",
"description": "Is the table managed by ClickPipes? Required field for all pipe types except database pipes (Postgres, MySQL, BigQuery)."
},
"tableDefinition": {
"properties": {
"engine": {
"properties": {
"type": {
"type": "string",
"description": "Engine type of the destination table.",
"enum": [
"MergeTree",
"ReplacingMergeTree",
"SummingMergeTree",
"Null"
]
},
"versionColumnId": {
"type": [
"string",
"null"
],
"description": "Column name to use as version for ReplacingMergeTree engine."
},
"columnIds": {
"type": "array",
"description": "Column names to sum for SummingMergeTree engine.",
"items": {
"type": "string"
}
}
},
"additionalProperties": false
},
"sortingKey": {
"type": "array",
"description": "Sorting key of the destination table. List of columns.",
"items": {
"type": "string"
}
},
"partitionBy": {
"type": "string",
"description": "Partition key SQL expression."
},
"primaryKey": {
"type": "string",
"description": "Primary key of SQL expression."
}
},
"additionalProperties": false
},
"columns": {
"type": "array",
"description": "Columns of the destination table. Required field for all pipe types except database pipes (Postgres, MySQL, BigQuery).",
"items": {
"properties": {
"name": {
"type": "string",
"description": "Name of the column."
},
"type": {
"type": "string",
"description": "Type of the column."
}
},
"additionalProperties": false
}
}
},
"additionalProperties": false
},
"fieldMappings": {
"type": "array",
"description": "Field mappings of the ClickPipe. Note that all destination columns must be included in the mappings.",
"items": {
"properties": {
"sourceField": {
"type": "string",
"description": "Source field name."
},
"destinationField": {
"type": "string",
"description": "Destination field name."
}
},
"additionalProperties": false
}
},
"settings": {
"properties": {
"streaming_max_insert_wait_ms": {
"type": [
"integer",
"null"
],
"description": "Streaming max insert wait time. Configures the max wait period before inserting data into the ClickHouse.",
"minimum": 500,
"maximum": 60000
},
"object_storage_concurrency": {
"type": [
"integer",
"null"
],
"description": "Object storage concurrency. Number of concurrent file processing threads",
"minimum": 1,
"maximum": 35
},
"object_storage_polling_interval_ms": {
"type": [
"integer",
"null"
],
"description": "Object storage polling interval. Configures the refresh interval for querying continuous ingest for new object storage data",
"minimum": 100,
"maximum": 3600000
},
"object_storage_max_insert_bytes": {
"type": [
"integer",
"null"
],
"description": "Max insert bytes. Number of bytes to process in a single insert batch",
"minimum": 10485760,
"maximum": 53687091200
},
"object_storage_max_file_count": {
"type": [
"integer",
"null"
],
"description": "Max file count. Maximum number of files to process in a single insert batch",
"minimum": 1,
"maximum": 10000
},
"clickhouse_max_threads": {
"type": [
"integer",
"null"
],
"description": "Max threads. Maximum number of concurrent threads for file processing",
"minimum": 0,
"maximum": 64
},
"clickhouse_max_insert_threads": {
"type": [
"integer",
"null"
],
"description": "Max insert threads. Maximum number of concurrent insert threads",
"minimum": 0,
"maximum": 16
},
"clickhouse_min_insert_block_size_bytes": {
"type": [
"integer",
"null"
],
"description": "Min insert block size bytes. Minimum size of data block for insert (in bytes)",
"minimum": 0,
"maximum": 10737418240
},
"clickhouse_max_download_threads": {
"type": [
"integer",
"null"
],
"description": "Max download threads. Maximum number of concurrent download threads",
"minimum": 0,
"maximum": 32
},
"clickhouse_parallel_distributed_insert_select": {
"type": [
"integer",
"null"
],
"description": "Parallel distributed insert select. Parallel distributed insert select setting",
"minimum": 0,
"maximum": 2
},
"object_storage_use_cluster_function": {
"type": [
"boolean",
"null"
],
"description": "use cluster function. Whether to use ClickHouse cluster function for distributed processing"
},
"clickhouse_parallel_view_processing": {
"type": [
"boolean",
"null"
],
"description": "parallel view processing. Whether to enable pushing to attached views concurrently instead of sequentially"
}
},
"additionalProperties": false
},
"createdAt": {
"type": "string",
"description": "Creation timestamp of the ClickPipe in ISO 8601 format.",
"format": "date-time"
},
"updatedAt": {
"type": "string",
"description": "Last update timestamp of the ClickPipe in ISO 8601 format.",
"format": "date-time"
}
},
"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_pipe_get_list --payload '{
"organizationId": "string",
"serviceId": "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`.