Skip to content

docs(managed-postgres): document slow query patterns API#6330

Open
amogiska wants to merge 2 commits into
mainfrom
amogiska/managed-postgres-slow-query-patterns-api
Open

docs(managed-postgres): document slow query patterns API#6330
amogiska wants to merge 2 commits into
mainfrom
amogiska/managed-postgres-slow-query-patterns-api

Conversation

@amogiska
Copy link
Copy Markdown
Contributor

@amogiska amogiska commented Jun 2, 2026

Summary

  • Document the two new Postgres slow query pattern endpoints (slowQueryPatternsGetList, slowQueryPatternGet) on the Managed Postgres OpenAPI page, with curl examples, query parameters, and representative JSON responses.
  • Add a Query insights API section to the Query Insights monitoring page that maps the Slow patterns table and detail flyout to their API endpoints, plus a Related pages link.
  • Cross-link the OpenAPI page and the Query Insights page so the concept/UI docs and the programmatic reference point at each other.

Scope is limited to the Managed Postgres service docs — no other Cloud sections or sidebar changes.


Note

Low Risk
Documentation-only changes to Managed Postgres guides; no runtime, API, or auth behavior is modified.

Overview
Documents how to call Managed Postgres slow query pattern APIs from the same telemetry as the Query Insights console.

The OpenAPI guide gains a Query insights section with curl examples for listing patterns (from_date / to_date, sort_by, filters, paging) and fetching one pattern by queryId (required db_name, db_user, db_operation), plus sample JSON and links to Swagger operations.

The Query insights monitoring page adds a short Query insights API section mapping the Slow patterns table and detail flyout to those endpoints, and Related pages / frontmatter keywords are updated for cross-navigation between UI docs and the programmatic reference.

Reviewed by Cursor Bugbot for commit fbe4332. Bugbot is set up for automated code reviews on this repo. Configure here.

@vercel
Copy link
Copy Markdown

vercel Bot commented Jun 2, 2026

The latest updates on your projects. Learn more about Vercel for GitHub.

Project Deployment Actions Updated (UTC)
clickhouse-docs Ready Ready Preview, Comment Jun 3, 2026 5:27pm
clickhouse-docs-jp Building Building Preview, Comment Jun 3, 2026 5:27pm
3 Skipped Deployments
Project Deployment Actions Updated (UTC)
clickhouse-docs-ko Ignored Ignored Preview Jun 3, 2026 5:27pm
clickhouse-docs-ru Ignored Ignored Preview Jun 3, 2026 5:27pm
clickhouse-docs-zh Ignored Ignored Preview Jun 3, 2026 5:27pm

Request Review

@mintlify
Copy link
Copy Markdown

mintlify Bot commented Jun 3, 2026

Docs PR opened: ClickHouse/mintlify-docs-dev#110

Documented the new Managed Postgres slow query patterns API endpoints and cross-linked them with the Query Insights monitoring page.

Once this PR is merged, we'll do a second pass to capture any additional changes and update the docs PR.

`from_date` and `to_date` as RFC 3339 timestamps:

```bash
FROM=2026-05-25T00:00:00Z
Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

When I tried this api timestamp had to be in milliseconds precision else it was giving 400. Can you please check once?

Copy link
Copy Markdown
Contributor

@theory theory left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This is a nice feature.

{
"result": [
{
"queryId": "-4748036479882663975",
Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

We have negative query IDs? o_O

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants