> ## Documentation Index
> Fetch the complete documentation index at: https://clickhouse.com/docs/llms.txt
> Use this file to discover all available pages before exploring further.
# ClickStack: List Saved Searches
> **This endpoint is in beta.** API contract is stable, and no breaking changes are expected in the future.
ClickStack: Retrieves saved searches for the authenticated team (paginated). Results are capped at `limit` (default and maximum 1000). When more records exist than are returned, `meta.total` exceeds `data.length`; clients with large collections must page with `limit`/`offset` to retrieve them all.
Beta
**This endpoint is in beta.** API contract is stable, and no breaking changes are expected in the future.
ClickStack: Retrieves saved searches for the authenticated team (paginated). Results are capped at `limit` (default and maximum 1000). When more records exist than are returned, `meta.total` exceeds `data.length`; clients with large collections must page with `limit`/`offset` to retrieve them all.
## OpenAPI
````yaml _specs/cloud-openapi.json GET /v1/organizations/{organizationId}/services/{serviceId}/clickstack/saved-searches
openapi: 3.1.2
info:
title: OpenAPI spec for ClickHouse Cloud
version: '1.0'
contact:
name: ClickHouse Support
url: >-
https://clickhouse.com/docs/en/cloud/manage/openapi?referrer=openapi-1047418
email: support@clickhouse.com
servers:
- url: https://api.clickhouse.cloud
security:
- basicAuth: []
tags:
- name: Organization
- name: User management
- name: Billing
- name: Role Management
- name: Service
- name: Backup
- name: OpenAPI
- name: Prometheus
- name: ClickPipes
- name: ClickStack
- name: Postgres
paths:
/v1/organizations/{organizationId}/services/{serviceId}/clickstack/saved-searches:
get:
tags:
- ClickStack
summary: 'ClickStack: List Saved Searches'
description: >-
**This endpoint is in beta.** API contract is stable, and no breaking
changes are expected in the future.
ClickStack: Retrieves
saved searches for the authenticated team (paginated). Results are
capped at `limit` (default and maximum 1000). When more records exist
than are returned, `meta.total` exceeds `data.length`; clients with
large collections must page with `limit`/`offset` to retrieve them all.
operationId: clickStackListSavedSearches
parameters:
- in: path
name: organizationId
description: ID of the organization that owns the service.
required: true
schema:
type: string
format: uuid
- in: path
name: serviceId
description: ID of the ClickStack service.
required: true
schema:
type: string
format: uuid
responses:
'200':
description: Successful response
content:
application/json:
schema:
type: object
properties:
status:
type: number
description: HTTP status code.
example: 200
requestId:
type: string
description: Unique id assigned to every request. UUIDv4
format: uuid
result:
type: array
items:
$ref: '#/components/schemas/ClickStackSavedSearch'
'400':
description: >-
The request cannot be processed due to a client error. Please verify
your request parameters and try again.
content:
application/json:
schema:
type: object
properties:
status:
type: number
description: HTTP status code.
example: 400
error:
type: string
description: Detailed error description.
requestId:
type: string
description: Unique id assigned to every request. UUIDv4
format: uuid
'500':
description: >-
An internal server error has occurred. If this issue persists,
please contact ClickHouse Cloud support for assistance.
content:
application/json:
schema:
type: object
properties:
status:
type: integer
description: HTTP status code.
example: 500
error:
type: string
description: Detailed error description.
requestId:
type: string
description: Unique id assigned to every request. UUIDv4
format: uuid
components:
schemas:
ClickStackSavedSearch:
properties:
id:
description: Unique saved search ID. Server-generated.
type: string
example: 507f1f77bcf86cd799439011
name:
description: Display name for the saved search.
type: string
example: Production Errors
sourceId:
description: ID of the source this saved search queries.
type: string
example: 507f1f77bcf86cd799439012
select:
description: >-
Comma-separated list of column expressions to display. Empty uses
the source default.
type: string
example: Timestamp, ServiceName, Body
where:
description: Row filter expression. The language is controlled by whereLanguage.
type: string
example: SeverityText:ERROR
whereLanguage:
description: Language used for the where filter.
type: string
enum:
- lucene
- sql
example: lucene
orderBy:
description: ORDER BY expression. Empty uses the source default.
type: string
example: Timestamp DESC
tags:
type: array
description: Tags used to organize saved searches.
items:
type: string
example:
- production
- errors
filters:
type: array
description: Structured pinned filters applied to the search.
items:
$ref: '#/components/schemas/ClickStackSavedSearchFilter'
example:
- >-
{"type":"sql","condition":"ServiceName IN ('checkout',
'payments')"}
teamId:
description: ID of the team that owns the saved search.
type: string
example: 507f1f77bcf86cd799439013
createdAt:
description: Creation timestamp.
type: string
format: date-time
example: '2025-01-01T00:00:00.000Z'
updatedAt:
description: Last update timestamp.
type: string
format: date-time
example: '2025-06-15T10:30:00.000Z'
required:
- id
- name
- sourceId
ClickStackSavedSearchFilter:
properties:
type:
description: Always `sql`. Only SQL predicate filters render in the sidebar.
type: string
enum:
- sql
example: sql
condition:
description: SQL predicate applied to the search, in ` IN (...)` form.
type: string
example: ServiceName IN ('checkout', 'payments')
required:
- condition
securitySchemes:
basicAuth:
type: http
scheme: basic
description: >-
Use key ID and key secret obtained in ClickHouse Cloud console:
https://clickhouse.com/docs/cloud/manage/openapi
````