Skip to main content
PUT
ClickStack: Update Saved Search
Beta 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.

Authorizations

Authorization
string
header
required

Use key ID and key secret obtained in ClickHouse Cloud console: https://clickhouse.com/docs/cloud/manage/openapi

Path Parameters

organizationId
string<uuid>
required

ID of the organization that owns the service.

serviceId
string<uuid>
required

ID of the ClickStack service.

clickStackSavedSearchId
string
required

Saved search ID

Body

application/json
name
string
required

Display name for the saved search.

Example:

"Production Errors"

sourceId
string
required

ID of the source to query. Must belong to the team.

Example:

"507f1f77bcf86cd799439012"

select
string

Comma-separated list of column expressions to display. Empty uses the source default.

Example:

"Timestamp, ServiceName, Body"

where
string

Row filter expression. The language is controlled by whereLanguage.

Example:

"SeverityText:ERROR"

whereLanguage
enum<string>

Language used for the where filter.

Available options:
lucene,
sql
Example:

"lucene"

orderBy
string

ORDER BY expression. Empty uses the source default.

Example:

"Timestamp DESC"

tags
string[]

Tags used to organize saved searches.

Example:
filters
object[]

Structured pinned filters applied to the search.

Example:

Response

Successful response

status
number

HTTP status code.

Example:

200

requestId
string<uuid>

Unique id assigned to every request. UUIDv4

result
object
Last modified on July 22, 2026