List Postgres slow query patterns

This endpoint is in beta. API contract is stable, and no breaking changes are expected in the future.

Returns aggregate metrics for the slowest query patterns observed on a Postgres service during the given time window. Use this to discover which queries dominate total execution time, CPU, I/O, or WAL generation.

GET /v1/organizations/{organizationId}/postgres/{postgresId}/slowQueryPatterns

List Postgres slow query patterns

cURL

curl --request GET \
  --url https://api.clickhouse.cloud/v1/organizations/{organizationId}/postgres/{postgresId}/slowQueryPatterns \
  --header 'Authorization: Basic <encoded-value>'

import requests

url = "https://api.clickhouse.cloud/v1/organizations/{organizationId}/postgres/{postgresId}/slowQueryPatterns"

headers = {"Authorization": "Basic <encoded-value>"}

response = requests.get(url, headers=headers)

print(response.text)

const options = {method: 'GET', headers: {Authorization: 'Basic <encoded-value>'}};

fetch('https://api.clickhouse.cloud/v1/organizations/{organizationId}/postgres/{postgresId}/slowQueryPatterns', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://api.clickhouse.cloud/v1/organizations/{organizationId}/postgres/{postgresId}/slowQueryPatterns",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "GET",
  CURLOPT_HTTPHEADER => [
    "Authorization: Basic <encoded-value>"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"net/http"
	"io"
)

func main() {

	url := "https://api.clickhouse.cloud/v1/organizations/{organizationId}/postgres/{postgresId}/slowQueryPatterns"

	req, _ := http.NewRequest("GET", url, nil)

	req.Header.Add("Authorization", "Basic <encoded-value>")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

HttpResponse<String> response = Unirest.get("https://api.clickhouse.cloud/v1/organizations/{organizationId}/postgres/{postgresId}/slowQueryPatterns")
  .header("Authorization", "Basic <encoded-value>")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://api.clickhouse.cloud/v1/organizations/{organizationId}/postgres/{postgresId}/slowQueryPatterns")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Get.new(url)
request["Authorization"] = 'Basic <encoded-value>'

response = http.request(request)
puts response.read_body

200

{
  "status": 200,
  "requestId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "result": [
    {
      "queryId": "<string>",
      "queryText": "<string>",
      "dbName": "<string>",
      "dbUser": "<string>",
      "dbOperation": "<string>",
      "app": "<string>",
      "callCount": 123,
      "errorCount": 123,
      "totalDurationUs": 123,
      "avgDurationUs": 123,
      "maxDurationUs": 123,
      "p50DurationUs": 123,
      "p95DurationUs": 123,
      "p99DurationUs": 123,
      "totalRows": 123,
      "totalSharedBlksRead": 123,
      "totalSharedBlksHit": 123,
      "totalCpuTimeUs": 123,
      "totalWalBytes": 123
    }
  ]
}

{
  "status": 400,
  "error": "<string>",
  "requestId": "3c90c3cc-0d44-4b50-8888-8dd25736052a"
}

{
  "status": 500,
  "error": "<string>",
  "requestId": "3c90c3cc-0d44-4b50-8888-8dd25736052a"
}

Beta

This endpoint is in beta. API contract is stable, and no breaking changes are expected in the future.

Returns aggregate metrics for the slowest query patterns observed on a Postgres service during the given time window. Use this to discover which queries dominate total execution time, CPU, I/O, or WAL generation.

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 Postgres service.

postgresId · string<uuid> · required

ID of the requested Postgres service.

Query Parameters

from_date · string<date-time> · required

Inclusive start of the time window (RFC 3339 date-time).

to_date · string<date-time> · required

Exclusive end of the time window (RFC 3339 date-time).

db_name · string

Database name filter.

db_user · string

Database user filter.

db_operation · string

Database operation filter (for example, SELECT, INSERT, UPDATE, DELETE, UTILITY).

app · string

Application name filter.

sort_by · enum<string> · default: total_duration

Field to sort results by.

Available options: total_duration, avg_duration, call_count, total_blks_read, total_cpu_time, error_count, max_duration, p50_duration, p95_duration, p99_duration, total_rows, total_shared_blks_hit, total_wal_bytes

sort_order · enum<string> · default: desc

Sort order. One of asc or desc.

Available options: asc, desc

limit · integer · default: 20

Maximum number of results to return.

Required range: 1 <= x <= 500

offset · integer · default: 0

Number of results to skip before returning.

Required range: x >= 0

Response

200

application/json

Successful response

status · number

HTTP status code.

Example:

200

requestId · string<uuid>

Unique id assigned to every request. UUIDv4

result · object[]

Show child attributes