> ## Documentation Index
> Fetch the complete documentation index at: https://deepline.com/docs/llms.txt
> Use this file to discover all available pages before exploring further.

# ClickHouse Cloud: Clickhouse Postgres Instance Metrics Get

> Get Postgres time-series metrics. Includes SDK V2 guidance, input constraints, response fields, and Deepline credit cost.

Get Postgres time-series metrics.

<Info>
  Tool ID: `clickhouse_postgres_instance_metrics_get`
</Info>

## Run this action

Use the TypeScript SDK for a single call. Put `ctx.tools.execute(...)` inside a Play when the call should be durable, scheduled, or run across a CSV.

```ts theme={null}
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

```bash theme={null}
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 exposes this shape at `result.toolResponse.raw`. Values below are representative.

```json theme={null}
{
  "data": {
    "status": 123,
    "requestId": "123e4567-e89b-42d3-a456-426614174000"
  }
}
```

Use `deepline tools get 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. |

<details>
  <summary>Show raw input schema</summary>

  ### Input JSON Schema

  ```json theme={null}
  {
    "type": "object",
    "description": "**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.",
    "properties": {
      "organizationId": {
        "type": "string",
        "description": "ID of the organization that owns the Postgres service.",
        "format": "uuid"
      },
      "postgresId": {
        "type": "string",
        "description": "ID of the Postgres service.",
        "format": "uuid"
      },
      "from_date": {
        "type": "string",
        "description": "Inclusive start of the time window (RFC 3339 date-time).",
        "format": "date-time"
      },
      "to_date": {
        "type": "string",
        "description": "Exclusive end of the time window (RFC 3339 date-time).",
        "format": "date-time"
      },
      "bucket_size_seconds": {
        "type": "integer",
        "description": "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
      }
    },
    "required": [
      "organizationId",
      "postgresId",
      "from_date",
      "to_date"
    ],
    "additionalProperties": false
  }
  ```
</details>

## 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). |

<details>
  <summary>Show raw output schema</summary>

  ### Output JSON Schema

  ```json theme={null}
  {
    "type": "object",
    "description": "Standard tool result payload.",
    "properties": {
      "data": {
        "type": "object",
        "description": "Provider response payload.",
        "properties": {
          "status": {
            "type": "number",
            "description": "HTTP status code."
          },
          "requestId": {
            "type": "string",
            "description": "Unique id assigned to every request. UUIDv4",
            "format": "uuid"
          },
          "result": {
            "properties": {
              "metrics": {
                "type": "array",
                "description": "Available metrics, each with its bucketed time series.",
                "items": {
                  "properties": {
                    "key": {
                      "type": "string",
                      "description": "Stable metric identifier (for example cpu_usage, connection_count, cache_hit_ratio)."
                    },
                    "name": {
                      "type": "string",
                      "description": "Human-readable metric name."
                    },
                    "unit": {
                      "type": "string",
                      "description": "Unit of the metric values (for example %, IOPS, bytes/s, count)."
                    },
                    "description": {
                      "type": "string",
                      "description": "Human-readable description of what the metric measures."
                    },
                    "series": {
                      "type": "array",
                      "description": "One series per label dimension of the metric.",
                      "items": {
                        "properties": {
                          "label": {
                            "type": "string",
                            "description": "Distinguishing label for this series within the metric (for example a CPU mode, a database name, or \"Reads\")."
                          },
                          "dataPoints": {
                            "type": "array",
                            "description": "Time-ordered data points, one per bucket.",
                            "items": {
                              "properties": {
                                "timestamp": {
                                  "type": "integer",
                                  "description": "Bucket start time as a Unix timestamp in seconds."
                                },
                                "value": {
                                  "type": "number",
                                  "description": "Metric value for the bucket."
                                }
                              },
                              "required": [
                                "timestamp",
                                "value"
                              ],
                              "additionalProperties": false
                            }
                          }
                        },
                        "required": [
                          "label",
                          "dataPoints"
                        ],
                        "additionalProperties": false
                      }
                    }
                  },
                  "required": [
                    "key",
                    "name",
                    "unit",
                    "description",
                    "series"
                  ],
                  "additionalProperties": false
                }
              }
            },
            "required": [
              "metrics"
            ],
            "additionalProperties": false
          }
        },
        "additionalProperties": false
      },
      "meta": {
        "type": "object",
        "description": "Additional response metadata (status, paging).",
        "additionalProperties": true
      }
    },
    "required": [
      "data"
    ],
    "additionalProperties": false
  }
  ```
</details>

## Deepline cost

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

## Related documentation

* [ClickHouse Cloud provider guide](/docs/providers/clickhouse/guide)
* [SDK V2 quickstart](/docs/sdk-v2/quickstart)
* [SDK reference](/docs/sdk-v2/sdk-reference)
* [Run tools across a CSV](/docs/sdk-v2/batch-csv)


This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.