PgBeam Docs
Analytics

Get query insights for a project

GET
/v1/projects/{project_id}/insights

Returns aggregated query-level analytics for a project including top queries by count, cache hit/miss summary, and latency statistics.

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

range?string

Time range to query. Defaults to 24h.

limit?integer

Maximum number of top queries to return (1-100).

Response Body

application/json

application/json

application/json

application/json

application/json

curl -X GET "https://example.com/v1/projects/string/insights"
{  "queries": [    {      "query_hash": "string",      "query_pattern": "string",      "total_count": 0,      "total_cache_hits": 0,      "total_cache_misses": 0,      "avg_latency_ms": 0.1,      "p99_latency_ms": 0.1    }  ],  "cache": {    "total_hits": 0,    "total_misses": 0,    "hit_rate": 0.1  },  "latency": {    "avg_ms": 0.1,    "p99_ms": 0.1  }}
{  "error": {    "code": "string",    "message": "string"  }}
{  "error": {    "code": "string",    "message": "string"  }}
{  "error": {    "code": "string",    "message": "string"  }}
{  "error": {    "code": "string",    "message": "string"  }}