ClickHouse Click Stack API
The ClickStack API from ClickHouse — 13 operation(s) for clickstack.
Operations 30
Each operation below carries the questions people ask an LLM about it and the instructions they give an agent to run it. Generated by API Evangelist overlay
GET
/v1/organizations/{organizationId}/services/{serviceId}/clickstack/dashboards
List ClickStack dashboards · ClickStack: List Dashboards
#
Ask an LLM
“Which observability dashboards exist in ClickStack for my service?”
“Can I see all of my team's ClickStack dashboards?”
Tell an agent
List all ClickStack dashboards on service {service} in org {org}.
Show every observability dashboard my team has for service {service} in organization {org}.
POST
/v1/organizations/{organizationId}/services/{serviceId}/clickstack/dashboards
Create a ClickStack dashboard · ClickStack: Create Dashboard
#
Ask an LLM
“How do I build a new observability dashboard with chart tiles in ClickStack?”
“Can I tag a new dashboard and give it default filters?”
Tell an agent
Create a ClickStack dashboard named {name} with tiles {tiles} on service {service} in org {org}.
Save a new dashboard {name} tagged {tags} with tiles {tiles} for service {service} in organization {org}.
GET
/v1/organizations/{organizationId}/services/{serviceId}/clickstack/dashboards/{clickStackDashboardId}
Get one ClickStack dashboard · ClickStack: Get Dashboard
#
Ask an LLM
“What tiles and filters are on a specific ClickStack dashboard?”
“Can I export the definition of one dashboard?”
Tell an agent
Get ClickStack dashboard {dashboard} on service {service} in org {org}.
Show the tiles of dashboard {dashboard} for service {service} in organization {org}.
PUT
/v1/organizations/{organizationId}/services/{serviceId}/clickstack/dashboards/{clickStackDashboardId}
Update an existing ClickStack dashboard · ClickStack: Update Dashboard
#
Ask an LLM
“How do I change the tiles on a dashboard I already built?”
“Does updating a dashboard protect against someone else editing it at the same time?”
Tell an agent
Update dashboard {dashboard} on service {service} in org {org} with name {name} and tiles {tiles}.
Replace the tiles on existing dashboard {dashboard} for service {service} in organization {org} with {tiles}, keeping name {name}.
DELETE
/v1/organizations/{organizationId}/services/{serviceId}/clickstack/dashboards/{clickStackDashboardId}
Delete a ClickStack dashboard · ClickStack: Delete Dashboard
#
Ask an LLM
“How do I remove a ClickStack dashboard nobody uses anymore?”
“Can I delete an observability dashboard by its ID?”
Tell an agent destructive · confirm first
Delete ClickStack dashboard {dashboard} on service {service} in org {org}.
Remove dashboard {dashboard} from service {service} in organization {org}.
POST
/v1/organizations/{organizationId}/services/{serviceId}/clickstack/dashboards/validate
Validate a dashboard definition without saving · ClickStack: Validate Dashboard
#
Ask an LLM
“Can I check a dashboard definition is valid before applying it from Terraform?”
“Is there a dry run that tests dashboard tiles without saving anything?”
Tell an agent
Validate dashboard {name} with tiles {tiles} for service {service} in org {org} without saving it.
Dry-run check the tile rules for dashboard config {name} ({tiles}) on service {service} in organization {org}.
GET
/v1/organizations/{organizationId}/services/{serviceId}/clickstack/alerts
List ClickStack alerts · ClickStack: List Alerts
#
Ask an LLM
“Which alerts are configured in ClickStack for my team?”
“How many alerts can I fetch per page, and how do I get the rest?”
Tell an agent
List ClickStack alerts on service {service} in org {org}.
Get {limit} alerts starting at offset {offset} for service {service} in organization {org}.
POST
/v1/organizations/{organizationId}/services/{serviceId}/clickstack/alerts
Create a ClickStack alert · ClickStack: Create Alert
#
Ask an LLM
“How do I get alerted when a saved search crosses a threshold?”
“Can I set an alert on a dashboard tile that notifies a webhook channel?”
Tell an agent
Create an alert named {name} on saved search {savedSearchId} firing above {threshold} every {interval} for service {service} in org {org}.
Alert on tile {tileId} of dashboard {dashboardId} via channel {channel} for service {service} in organization {org}.
GET
/v1/organizations/{organizationId}/services/{serviceId}/clickstack/sources
List ClickStack data sources · ClickStack: List Sources
#
Ask an LLM
“Which log, trace and metric sources are defined in ClickStack?”
“What data sources can my ClickStack searches and dashboards use?”
Tell an agent
List all ClickStack sources on service {service} in org {org}.
Show the observability data sources defined for service {service} in organization {org}.
POST
/v1/organizations/{organizationId}/services/{serviceId}/clickstack/sources
Create a ClickStack data source · ClickStack: Create Source
#
Ask an LLM
“How do I register a new table as a ClickStack source?”
“What granularity format do materialized views on a new source accept?”
Tell an agent
Create a new ClickStack source on service {service} in org {org}.
Register a new observability source for service {service} in organization {org}.
GET
/v1/organizations/{organizationId}/services/{serviceId}/clickstack/sources/{clickStackSourceId}
Get one ClickStack data source · ClickStack: Get Source
#
Ask an LLM
“How is a specific ClickStack source configured?”
“Which table and materialized views does one source point at?”
Tell an agent
Get ClickStack source {source} on service {service} in org {org}.
Show the configuration of source {source} for service {service} in organization {org}.
PUT
/v1/organizations/{organizationId}/services/{serviceId}/clickstack/sources/{clickStackSourceId}
Replace a ClickStack data source · ClickStack: Update Source
#
Ask an LLM
“Do I have to send the whole source object to change one ClickStack source?”
“How do I update the settings of an existing source?”
Tell an agent
Update ClickStack source {source} on service {service} in org {org} with its full new definition.
Replace the existing source {source} for service {service} in organization {org}.
DELETE
/v1/organizations/{organizationId}/services/{serviceId}/clickstack/sources/{clickStackSourceId}
Delete a ClickStack data source · ClickStack: Delete Source
#
Ask an LLM
“How do I remove a data source from ClickStack?”
“Can I delete a source I registered by mistake?”
Tell an agent destructive · confirm first
Delete ClickStack source {source} on service {service} in org {org}.
Remove observability source {source} from service {service} in organization {org}.
GET
/v1/organizations/{organizationId}/services/{serviceId}/clickstack/alerts/{clickStackAlertId}
Get one ClickStack alert · ClickStack: Get Alert
#
Ask an LLM
“What threshold and channel is a specific alert using?”
“Which saved search or tile does one of my alerts watch?”
Tell an agent
Get ClickStack alert {alert} on service {service} in org {org}.
Show the threshold and schedule of alert {alert} for service {service} in organization {org}.
PUT
/v1/organizations/{organizationId}/services/{serviceId}/clickstack/alerts/{clickStackAlertId}
Update an existing ClickStack alert · ClickStack: Update Alert
#
Ask an LLM
“How do I raise the threshold on an alert that's too noisy?”
“Can I change which channel an existing alert notifies?”
Tell an agent
Change the threshold of alert {alert} on service {service} in org {org} to {threshold}.
Point existing alert {alert} for service {service} in organization {org} at channel {channel} with message {message}.
DELETE
/v1/organizations/{organizationId}/services/{serviceId}/clickstack/alerts/{clickStackAlertId}
Delete a ClickStack alert · ClickStack: Delete Alert
#
Ask an LLM
“How do I delete an alert that no longer matters?”
“Can I remove a ClickStack alert by its ID?”
Tell an agent destructive · confirm first
Delete ClickStack alert {alert} on service {service} in org {org}.
Remove alert {alert} from service {service} in organization {org}.
GET
/v1/organizations/{organizationId}/services/{serviceId}/clickstack/webhooks
List ClickStack notification webhooks · ClickStack: List Webhooks
#
Ask an LLM
“Which webhooks can my ClickStack alerts send notifications to?”
“How do I page through a long list of ClickStack webhooks?”
Tell an agent
List ClickStack webhooks on service {service} in org {org}.
Get {limit} webhooks from offset {offset} for service {service} in organization {org}.
POST
/v1/organizations/{organizationId}/services/{serviceId}/clickstack/webhooks
Create a ClickStack notification webhook · ClickStack: Create Webhook
#
Ask an LLM
“How do I send ClickStack alert notifications to my own URL?”
“Can I add custom headers and a body template to an alert webhook?”
Tell an agent
Create a webhook named {name} for {webhookService} posting to {url} on service {service} in org {org}.
Add a {webhookService} webhook {name} at {url} with headers {headers} for service {service} in organization {org}.
PUT
/v1/organizations/{organizationId}/services/{serviceId}/clickstack/webhooks/{clickStackWebhookId}
Replace a ClickStack notification webhook · ClickStack: Update Webhook
#
Ask an LLM
“How do I change the URL an existing alert webhook posts to?”
“Does updating a webhook replace all of its fields?”
Tell an agent
Update webhook {webhook} on service {service} in org {org} to post to {url} as {name} via {webhookService}.
Replace existing webhook {webhook} for service {service} in organization {org} with name {name}, type {webhookService} and URL {url}.
DELETE
/v1/organizations/{organizationId}/services/{serviceId}/clickstack/webhooks/{clickStackWebhookId}
Delete a ClickStack notification webhook · ClickStack: Delete Webhook
#
Ask an LLM
“Why can't I delete a webhook that alerts still use?”
“How do I remove a notification webhook from ClickStack?”
Tell an agent destructive · confirm first
Delete webhook {webhook} on service {service} in org {org}.
Remove the unused alert webhook {webhook} from service {service} in organization {org}.
GET
/v1/organizations/{organizationId}/services/{serviceId}/clickstack/roles
List ClickStack team roles · ClickStack: List Roles
#
Ask an LLM
“Which predefined and custom roles exist for my ClickStack team?”
“What ClickStack roles can I give teammates?”
Tell an agent
List ClickStack roles on service {service} in org {org}.
Show the predefined and custom ClickStack team roles for service {service} in organization {org}.
POST
/v1/organizations/{organizationId}/services/{serviceId}/clickstack/roles
Create a custom ClickStack team role · ClickStack: Create Role
#
Ask an LLM
“How do I create a ClickStack role with limited permissions for my observability team?”
“Can a custom ClickStack role have its own description?”
Tell an agent
Create a ClickStack role {name} with permissions {permissions} on service {service} in org {org}.
Add a custom ClickStack team role {name} described as {description} granting {permissions} for service {service} in organization {org}.
GET
/v1/organizations/{organizationId}/services/{serviceId}/clickstack/roles/{clickStackRoleId}
Get one ClickStack team role · ClickStack: Get Role
#
Ask an LLM
“What permissions does a specific ClickStack role include?”
“Is a given ClickStack role predefined or custom?”
Tell an agent
Get ClickStack role {role} on service {service} in org {org}.
Show the permissions of ClickStack team role {role} for service {service} in organization {org}.
PUT
/v1/organizations/{organizationId}/services/{serviceId}/clickstack/roles/{clickStackRoleId}
Update a custom ClickStack team role · ClickStack: Update Role
#
Ask an LLM
“How do I change the permissions on a custom ClickStack role?”
“Can predefined ClickStack roles be edited?”
Tell an agent
Set the permissions of ClickStack role {role} on service {service} in org {org} to {permissions}.
Rename custom ClickStack role {role} to {name} with permissions {permissions} for service {service} in organization {org}.
DELETE
/v1/organizations/{organizationId}/services/{serviceId}/clickstack/roles/{clickStackRoleId}
Delete a custom ClickStack team role · ClickStack: Delete Role
#
Ask an LLM
“Why won't ClickStack let me delete a role that's assigned to users?”
“How do I remove a custom ClickStack role?”
Tell an agent destructive · confirm first
Delete ClickStack role {role} on service {service} in org {org}.
Remove the unused custom ClickStack team role {role} from service {service} in organization {org}.
GET
/v1/organizations/{organizationId}/services/{serviceId}/clickstack/saved-searches
List ClickStack saved searches · ClickStack: List Saved Searches
#
Ask an LLM
“Which saved log and trace searches does my team have in ClickStack?”
“Can I page through saved searches with limit and offset?”
Tell an agent
List ClickStack saved searches on service {service} in org {org}.
Get {limit} saved searches from offset {offset} for service {service} in organization {org}.
POST
/v1/organizations/{organizationId}/services/{serviceId}/clickstack/saved-searches
Save a ClickStack search · ClickStack: Create Saved Search
#
Ask an LLM
“How do I save a log search with a where clause so my team can reuse it?”
“Can a saved search specify which columns to select and how to sort?”
Tell an agent
Save a search named {name} on source {sourceId} where {where} for service {service} in org {org}.
Create saved search {name} over source {sourceId} selecting {select} ordered by {orderBy} for service {service} in organization {org}.
GET
/v1/organizations/{organizationId}/services/{serviceId}/clickstack/saved-searches/{clickStackSavedSearchId}
Get one ClickStack saved search · ClickStack: Get Saved Search
#
Ask an LLM
“What query and filters does a particular saved search use?”
“Which source is a specific saved search built on?”
Tell an agent
Get saved search {search} on service {service} in org {org}.
Show the where clause of saved search {search} for service {service} in organization {org}.
PUT
/v1/organizations/{organizationId}/services/{serviceId}/clickstack/saved-searches/{clickStackSavedSearchId}
Replace an existing ClickStack saved search · ClickStack: Update Saved Search
#
Ask an LLM
“How do I change the filter on a search I already saved?”
“Does updating a saved search overwrite fields I leave out?”
Tell an agent
Update saved search {search} on service {service} in org {org} to name {name}, source {sourceId}, where {where}.
Replace existing saved search {search} for service {service} in organization {org} with name {name} on source {sourceId}.
DELETE
/v1/organizations/{organizationId}/services/{serviceId}/clickstack/saved-searches/{clickStackSavedSearchId}
Delete a ClickStack saved search and its alerts · ClickStack: Delete Saved Search
#
Ask an LLM
“What happens to alerts attached to a saved search when I delete it?”
“How do I remove a saved search from ClickStack?”
Tell an agent destructive · confirm first
Delete saved search {search} on service {service} in org {org}.
Remove saved search {search} and any alerts on it from service {service} in organization {org}.