ClickHouse Cloud: Clickhouse Click Stack Update Saved Search

Replace a ClickStack saved search’s query, filters, columns and sort order.

Tool ID: clickhouse_click_stack_update_saved_search

Run this action

Use the TypeScript SDK for one call. Use ctx.tools.execute(...) inside a Play for durable calls, scheduled calls, or CSV processing.

import { Deepline } from 'deepline';

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

console.log(result.toolResponse.raw);

CLI

deepline tools execute clickhouse_click_stack_update_saved_search --input '{
  "organizationId": "123e4567-e89b-42d3-a456-426614174000",
  "serviceId": "123e4567-e89b-42d3-a456-426614174000",
  "clickStackSavedSearchId": "click_stack_saved_search_123",
  "name": "Example",
  "sourceId": "source_123"
}' --json

Example response

The SDK returns this shape at result.toolResponse.raw. The example values illustrate the response.

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

Use deepline describe clickhouse_click_stack_update_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: Updates an existing saved search. This is a full replace: send the full object. Every optional field (select, where, whereLanguage, orderBy, tags, filters) is always written and falls back to its default when omitted, so omitting a field resets it rather than preserving the stored value.

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.clickStackSavedSearchId`	`string`	Yes	—	Saved search ID
`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.

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

Deepline cost

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

​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