Skip to content

API: Saved Queries

The workspace SQL library. All endpoints require authentication unless noted. 8 endpoints.

List saved queries (paginated)

Query parameters

Name Type Required Description
limit integer no
offset integer no
search string no
sourceId string no
modelId string no
tag string no
dashboardId string no
unused boolean no
favorite boolean no
sort "recent" | "name" | "created" no

Responses: 200

Save a query

Request body (JSON)

Field Type Required Description
name string yes
description string no
sql string yes
sourceId string no
modelId string no

Responses: 200

Get a saved query

Path parameters

Name Type Required Description
id string yes

Responses: 200

Update a saved query

Path parameters

Name Type Required Description
id string yes

Request body (JSON)

Field Type Required Description
name string no
description string,null no
sql string no
sourceId string,null no
modelId string,null no

Responses: 200

Delete a saved query

Path parameters

Name Type Required Description
id string yes

Responses: 200

Favorite a saved query

Path parameters

Name Type Required Description
id string yes

Responses: 200

Unfavorite a saved query

Path parameters

Name Type Required Description
id string yes

Responses: 200

Set the tags on a saved query

Path parameters

Name Type Required Description
id string yes

Request body (JSON)

Field Type Required Description
tagIds array of string yes

Responses: 200