> ## 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 Postgres Instance Metrics Get: Inputs, Cost &

> Get Postgres time-series metrics. Includes inputs, outputs, pricing notes, Deepline CLI examples, and GTM automation guidance.

## Run in Enrichment Spreadsheet

<Info>
  Use this function as a column step in `deepline enrich`.
</Info>

```bash theme={null}
deepline enrich --input leads.csv --output leads.enriched.csv --with 'result=clickhouse_postgres_instance_metrics_get:{"organizationId":"{{organizationId}}","postgresId":"{{postgresId}}","from_date":"{{from_date}}","to_date":"{{to_date}}"}' --json
```

<Tip>
  Map payload values to spreadsheet columns with `{{column_name}}` placeholders.
</Tip>

## Input Schema

| Name                          | Type      | Required | Default | Description                                                                                                                                   |
| ----------------------------- | --------- | -------- | ------- | --------------------------------------------------------------------------------------------------------------------------------------------- |
| `payload.organizationId`      | `string`  | Yes      |         | ID of the organization that owns the Postgres service.                                                                                        |
| `payload.postgresId`          | `string`  | Yes      |         | ID of the Postgres service.                                                                                                                   |
| `payload.from_date`           | `string`  | Yes      |         | Inclusive start of the time window (RFC 3339 date-time).                                                                                      |
| `payload.to_date`             | `string`  | Yes      |         | Exclusive end of the time window (RFC 3339 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. |

<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 Schema

| Name          | Type     | Required | Default | Description                                    |
| ------------- | -------- | -------- | ------- | ---------------------------------------------- |
| `result.data` | `object` | Yes      |         | Provider response payload.                     |
| `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>

## Advanced: Direct CLI

<Info>
  Use direct execution for single payload debugging.
</Info>

```bash theme={null}
deepline tools execute clickhouse_postgres_instance_metrics_get --payload '{
  "organizationId": "string",
  "postgresId": "string",
  "from_date": "string",
  "to_date": "string"
}' --json
```

### CLI flags

| Flag                        | Description                                         |
| --------------------------- | --------------------------------------------------- |
| `--json`                    | Print machine-readable output.                      |
| `--wait`                    | Wait for terminal provider status when supported.   |
| `--debug`                   | Enable wait mode with additional status/log output. |
| `--wait-timeout SECONDS`    | Max seconds to wait in wait mode.                   |
| `--poll-interval SECONDS`   | Polling interval in seconds during wait mode.       |
| `--timeout SECONDS`         | Request timeout in seconds.                         |
| `--connect-timeout SECONDS` | Connection timeout in seconds.                      |

## Cost

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