PgBeam Docs
Projects

Get project metrics

GET
/v1/projects/{project_id}/metrics

Returns recent project metrics snapshots, optionally filtered by region.

Authorization

AuthorizationBearer <token>

JWT issued by Better Auth. Verified via JWKS.

In: header

Path Parameters

project_id*string

Unique project identifier (prefixed, e.g. prj_xxx).

Query Parameters

limit?integer

Maximum number of recent snapshots to return.

region?string

Filter metrics by region code.

Response Body

application/json

application/json

application/json

application/json

application/json

curl -X GET "https://example.com/v1/projects/string/metrics"
{  "snapshots": [    {      "id": "string",      "project_id": "string",      "region": "string",      "queries_total": 0,      "cache_hits": 0,      "cache_misses": 0,      "active_connections": 0,      "avg_latency_ms": 0.1,      "p99_latency_ms": 0.1,      "avg_connect_ms": 0.1,      "avg_query_ms": 0.1,      "created_at": "2019-08-24T14:15:22Z"    }  ]}
{  "error": {    "code": "string",    "message": "string"  }}
{  "error": {    "code": "string",    "message": "string"  }}
{  "error": {    "code": "string",    "message": "string"  }}
{  "error": {    "code": "string",    "message": "string"  }}