ClickHouse Cloud: Clickhouse Postgres Instance Metrics Get

Get CPU, memory, disk and network metrics over time for a ClickHouse Cloud Postgres service.

Tool ID: clickhouse_postgres_instance_metrics_get

Run this action

Use the TypeScript SDK for one call. Use ctx.tools.execute(...) inside a Play for durable calls, scheduled calls, or CSV processing.

import { Deepline } from 'deepline';

const deepline = await Deepline.connect();
const result = await deepline.tools.execute(
  'clickhouse_postgres_instance_metrics_get',
  {
    "organizationId": "123e4567-e89b-42d3-a456-426614174000",
    "postgresId": "123e4567-e89b-42d3-a456-426614174000",
    "from_date": "2026-01-15T12:00:00Z",
    "to_date": "2026-01-15T12:00:00Z"
  },
);

console.log(result.toolResponse.raw);

CLI

deepline tools execute clickhouse_postgres_instance_metrics_get --input '{
  "organizationId": "123e4567-e89b-42d3-a456-426614174000",
  "postgresId": "123e4567-e89b-42d3-a456-426614174000",
  "from_date": "2026-01-15T12:00:00Z",
  "to_date": "2026-01-15T12:00:00Z"
}' --json

Example response

The SDK returns this shape at result.toolResponse.raw. The example values illustrate the response.

{
  "data": {
    "status": 123,
    "requestId": "123e4567-e89b-42d3-a456-426614174000"
  }
}

Use deepline describe clickhouse_postgres_instance_metrics_get --json for the latest machine-readable contract.

Input reference

This endpoint is in beta. API contract is stable, and no breaking changes are expected in the future. Returns bucketed time-series metrics for a PostgreSQL service over the requested window (CPU, memory, disk, network, connections, cache hit ratio, throughput, transactions, and more). Use this to chart or analyze how a service behaved over time.

Name	Type	Required	Default	Details
`payload.organizationId`	`string`	Yes	—	ID of the organization that owns the Postgres service. Format: `uuid`.
`payload.postgresId`	`string`	Yes	—	ID of the Postgres service. Format: `uuid`.
`payload.from_date`	`string`	Yes	—	Inclusive start of the time window (RFC 3339 date-time). Format: `date-time`.
`payload.to_date`	`string`	Yes	—	Exclusive end of the time window (RFC 3339 date-time). Format: `date-time`.
`payload.bucket_size_seconds`	`integer`	No	—	Time-series bucket size in seconds. When omitted, a bucket size is derived from the requested window. Requests are capped at 250 data points. Minimum: 1.

Output reference

Standard tool result payload.

Name	Type	Required	Default	Details
`result.data`	`object`	Yes	—	Provider response payload.
`result.data.status`	`number`	No	—	HTTP status code.
`result.data.requestId`	`string`	No	—	Unique id assigned to every request. UUIDv4 Format: `uuid`.
`result.data.result`	`object`	No	—	—
`result.data.result.metrics`	`array`	Yes	—	Available metrics, each with its bucketed time series.
`result.data.result.metrics[].key`	`string`	Yes	—	Stable metric identifier (for example cpu_usage, connection_count, cache_hit_ratio).
`result.data.result.metrics[].name`	`string`	Yes	—	Human-readable metric name.
`result.data.result.metrics[].unit`	`string`	Yes	—	Unit of the metric values (for example %, IOPS, bytes/s, count).
`result.data.result.metrics[].description`	`string`	Yes	—	Human-readable description of what the metric measures.
`result.data.result.metrics[].series`	`array`	Yes	—	One series per label dimension of the metric.
`result.data.result.metrics[].series[].label`	`string`	Yes	—	Distinguishing label for this series within the metric (for example a CPU mode, a database name, or “Reads”).
`result.data.result.metrics[].series[].dataPoints`	`array`	Yes	—	Time-ordered data points, one per bucket.
`result.data.result.metrics[].series[].dataPoints[].timestamp`	`integer`	Yes	—	Bucket start time as a Unix timestamp in seconds.
`result.data.result.metrics[].series[].dataPoints[].value`	`number`	Yes	—	Metric value for the bucket.
`result.meta`	`object`	No	—	Additional response metadata (status, paging).

Deepline cost

Pricing model: fixed (per call).
Estimated Deepline credits: 0 per pricing unit.
Provider-native pricing may still exist outside Deepline credit billing.

​Run this action

​CLI

​Example response

​Input reference

​Output reference

​Deepline cost

​Related documentation

Run this action

CLI

Example response

Input reference

Output reference

Deepline cost

Related documentation