PgBeam Docs
Analytics

GetProjectInsights

Get query insights for a project

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

Usage

result, err := client.Analytics.GetProjectInsights(ctx, "prj_xxx", nil)

Parameters

ParameterTypeRequiredDescription
ctxcontext.ContextYesRequest context
projectIDstringYesUnique project identifier (prefixed, e.g. prj_xxx).
params*pgbeam.GetProjectInsightsParamsNoQuery parameters
params.RangestringNoTime range to query. Defaults to 24h.
params.LimitintNoMaximum number of top queries to return (1-100).

Response

(*pgbeam.ProjectInsights, error) — query insights for the project.

Example

import pgbeam "github.com/pgbeam/pgbeam-go"

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

result, err := client.Analytics.GetProjectInsights(ctx, "prj_xxx", &pgbeam.GetProjectInsightsParams{
    Range: "...",
    Limit: 20,
  })
if err != nil {
  log.Fatal(err)
}
fmt.Println(result)

Errors

StatusDescription
400Invalid request parameters.
401Missing or invalid authentication.
404Resource not found.
429Rate limited. Try again later.

On this page