> ## 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 Create Saved Search

> ClickStack: Create Saved Search. Includes SDK V2 guidance, input constraints, response fields, and Deepline credit cost.

ClickStack: Create Saved Search.

<Info>
  Tool ID: `clickhouse_click_stack_create_saved_search`
</Info>

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

```ts theme={null}
import { Deepline } from 'deepline';

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

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

### CLI

```bash theme={null}
deepline tools execute clickhouse_click_stack_create_saved_search --input '{
  "organizationId": "123e4567-e89b-42d3-a456-426614174000",
  "serviceId": "123e4567-e89b-42d3-a456-426614174000",
  "name": "Example",
  "sourceId": "source_123"
}' --json
```

## Example response

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

```json theme={null}
{
  "data": {
    "status": 123,
    "requestId": "123e4567-e89b-42d3-a456-426614174000",
    "result": {
      "id": "id_123",
      "name": "Example",
      "sourceId": "source_123"
    }
  }
}
```

Use `deepline tools get clickhouse_click_stack_create_saved_search --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: Creates a new saved search.

| 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.name` | `string` | Yes | — | Display name for the saved search. |
| `payload.sourceId` | `string` | Yes | — | ID of the source to query. Must belong to the team. |
| `payload.select` | `string` | No | — | Comma-separated list of column expressions to display. Empty uses the source default. |
| `payload.where` | `string` | No | — | Row filter expression. The language is controlled by whereLanguage. |
| `payload.whereLanguage` | `"lucene" \| "sql"` | No | — | Language used for the where filter. Allowed: `lucene`, `sql`. |
| `payload.orderBy` | `string` | No | — | ORDER BY expression. Empty uses the source default. |
| `payload.tags` | `array` | No | — | Tags used to organize saved searches. |
| `payload.filters` | `array` | No | — | Structured pinned filters applied to the search. |

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

  ### 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: Creates a new saved search.",
    "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"
      },
      "name": {
        "type": "string",
        "description": "Display name for the saved search."
      },
      "sourceId": {
        "type": "string",
        "description": "ID of the source to query. Must belong to the team."
      },
      "select": {
        "type": "string",
        "description": "Comma-separated list of column expressions to display. Empty uses the source default."
      },
      "where": {
        "type": "string",
        "description": "Row filter expression. The language is controlled by whereLanguage."
      },
      "whereLanguage": {
        "type": "string",
        "description": "Language used for the where filter.",
        "enum": [
          "lucene",
          "sql"
        ]
      },
      "orderBy": {
        "type": "string",
        "description": "ORDER BY expression. Empty uses the source default."
      },
      "tags": {
        "type": "array",
        "description": "Tags used to organize saved searches.",
        "items": {
          "type": "string"
        }
      },
      "filters": {
        "type": "array",
        "description": "Structured pinned filters applied to the search.",
        "items": {
          "properties": {
            "type": {
              "type": "string",
              "description": "Always `sql`. Only SQL predicate filters render in the sidebar.",
              "enum": [
                "sql"
              ]
            },
            "condition": {
              "type": "string",
              "description": "SQL predicate applied to the search, in ` IN (...)` form."
            }
          },
          "required": [
            "condition"
          ],
          "additionalProperties": false
        }
      }
    },
    "required": [
      "organizationId",
      "serviceId",
      "name",
      "sourceId"
    ],
    "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` | Yes | — | Unique saved search ID. Server-generated. |
| `result.data.result.name` | `string` | Yes | — | Display name for the saved search. |
| `result.data.result.sourceId` | `string` | Yes | — | ID of the source this saved search queries. |
| `result.data.result.select` | `string` | No | — | Comma-separated list of column expressions to display. Empty uses the source default. |
| `result.data.result.where` | `string` | No | — | Row filter expression. The language is controlled by whereLanguage. |
| `result.data.result.whereLanguage` | `"lucene" \| "sql"` | No | — | Language used for the where filter. Allowed: `lucene`, `sql`. |
| `result.data.result.orderBy` | `string` | No | — | ORDER BY expression. Empty uses the source default. |
| `result.data.result.tags` | `array` | No | — | Tags used to organize saved searches. |
| `result.data.result.filters` | `array` | No | — | Structured pinned filters applied to the search. |
| `result.data.result.filters[].type` | `"sql"` | No | — | Always `sql`. Only SQL predicate filters render in the sidebar. Allowed: `sql`. |
| `result.data.result.filters[].condition` | `string` | Yes | — | SQL predicate applied to the search, in ` IN (...)` form. |
| `result.data.result.teamId` | `string` | No | — | ID of the team that owns the saved search. |
| `result.data.result.createdAt` | `string` | No | — | Creation timestamp. Format: `date-time`. |
| `result.data.result.updatedAt` | `string` | No | — | Last update timestamp. Format: `date-time`. |
| `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": {
        "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": "Unique saved search ID. Server-generated."
              },
              "name": {
                "type": "string",
                "description": "Display name for the saved search."
              },
              "sourceId": {
                "type": "string",
                "description": "ID of the source this saved search queries."
              },
              "select": {
                "type": "string",
                "description": "Comma-separated list of column expressions to display. Empty uses the source default."
              },
              "where": {
                "type": "string",
                "description": "Row filter expression. The language is controlled by whereLanguage."
              },
              "whereLanguage": {
                "type": "string",
                "description": "Language used for the where filter.",
                "enum": [
                  "lucene",
                  "sql"
                ]
              },
              "orderBy": {
                "type": "string",
                "description": "ORDER BY expression. Empty uses the source default."
              },
              "tags": {
                "type": "array",
                "description": "Tags used to organize saved searches.",
                "items": {
                  "type": "string"
                }
              },
              "filters": {
                "type": "array",
                "description": "Structured pinned filters applied to the search.",
                "items": {
                  "properties": {
                    "type": {
                      "type": "string",
                      "description": "Always `sql`. Only SQL predicate filters render in the sidebar.",
                      "enum": [
                        "sql"
                      ]
                    },
                    "condition": {
                      "type": "string",
                      "description": "SQL predicate applied to the search, in ` IN (...)` form."
                    }
                  },
                  "required": [
                    "condition"
                  ],
                  "additionalProperties": false
                }
              },
              "teamId": {
                "type": "string",
                "description": "ID of the team that owns the saved search."
              },
              "createdAt": {
                "type": "string",
                "description": "Creation timestamp.",
                "format": "date-time"
              },
              "updatedAt": {
                "type": "string",
                "description": "Last update timestamp.",
                "format": "date-time"
              }
            },
            "required": [
              "id",
              "name",
              "sourceId"
            ],
            "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](/docs/providers/clickhouse/guide)
* [SDK V2 quickstart](/docs/sdk-v2/quickstart)
* [SDK reference](/docs/sdk-v2/sdk-reference)
* [Run tools across a CSV](/docs/sdk-v2/batch-csv)


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