---
title: "GetProjectMetrics"
description: "Get project metrics"
canonical: "https://pgbeam.com/docs/go-sdk/projects/getProjectMetrics"
last-updated: "2026-10-29T19:01:20.000Z"
---

# GetProjectMetrics

> Get project metrics

URL: https://pgbeam.com/docs/go-sdk/projects/getProjectMetrics

{/* Auto-generated from OpenAPI. Do not edit. Run `pnpm generate:sdk-docs` to regenerate. */}

Returns recent project metrics snapshots, optionally filtered by region.

## Usage

```go
result, err := client.Projects.GetProjectMetrics(ctx, "prj_xxx", nil)
```

## Parameters

| Parameter          | Type                              | Required | Description                                                                                                                                                                                                                                                                                                                                             |
| ------------------ | --------------------------------- | -------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| ctx                | `context.Context`                 | Yes      | Request context                                                                                                                                                                                                                                                                                                                                         |
| projectID          | `string`                          | Yes      | Unique project identifier (prefixed, e.g. prj_xxx).                                                                                                                                                                                                                                                                                                     |
| params             | `*pgbeam.GetProjectMetricsParams` | No       | Query and header parameters                                                                                                                                                                                                                                                                                                                             |
| params.Limit       | `*int`                            | No       | Maximum number of recent snapshots to return.                                                                                                                                                                                                                                                                                                           |
| params.Region      | `*string`                         | No       | Filter metrics by region code.                                                                                                                                                                                                                                                                                                                          |
| params.IfNoneMatch | `*string`                         | No       | Entity tag the client already holds, taken from the `ETag` of an earlier response. When it still matches the current representation the server answers `304 Not Modified` with no body, so a poll that finds nothing changed costs a round trip rather than a transfer. A comma-separated list is accepted, and `*` matches any current representation. |

## Response

`(*pgbeam.ProjectMetricsResponse, error)`: metrics snapshots

## Example

```go
import pgbeam "go.pgbeam.com/sdk"

client := pgbeam.NewClient(&pgbeam.ClientOptions{
  APIKey: "pbu_...",
})

limit := 60
region := "us-east-1"
result, err := client.Projects.GetProjectMetrics(ctx, "prj_xxx", &pgbeam.GetProjectMetricsParams{
    Limit: &limit,
    Region: &region,
  })
if err != nil {
  log.Fatal(err)
}
fmt.Println(result)
```

## Errors

| Status | Description                                                                                                                         |
| ------ | ----------------------------------------------------------------------------------------------------------------------------------- |
| 400    | The request was rejected. `code` is `INVALID_INPUT`, and `errors` names the offending fields when the failure was a validation one. |
| 401    | Missing or invalid authentication. `code` is `UNAUTHORIZED`.                                                                        |
| 404    | The resource does not exist, or the caller is not entitled to know that it does. `code` is `NOT_FOUND`.                             |
| 429    | Rate limited. `code` is `RATE_LIMITED`.                                                                                             |
| 500    | The request failed for a reason on our side. `code` is `INTERNAL_ERROR`. Quote `request_id` when reporting it.                      |