---
title: "getProjectMetrics"
description: "Get project metrics"
canonical: "https://pgbeam.com/docs/ts-sdk/projects/getProjectMetrics"
last-updated: "2026-09-14T19:37:21.000Z"
---

# getProjectMetrics

> Get project metrics

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

Returns recent project metrics snapshots, optionally filtered by region.

## Usage

## Parameters

Parameter

Type

Required

Description

pathParams.project\_id

`string`

Yes

Unique project identifier (prefixed, e.g. prj\_xxx).

queryParams.limit

`number`

No

Maximum number of recent snapshots to return.

queryParams.region

`string`

No

Filter metrics by region code.

## Response

`Promise<ProjectMetricsResponse>`: metrics snapshots

## Example

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