PgBeam Docs
Analytics

GetProjectUsage

Get project usage

Returns daily usage data for a specific project, broken down by region.

Usage

result, err := client.Analytics.GetProjectUsage(ctx, "prj_xxx", &pgbeam.GetProjectUsageParams{
    StartDate: "...",
    EndDate: "...",
  })

Parameters

ParameterTypeRequiredDescription
ctxcontext.ContextYesRequest context
projectIDstringYesUnique project identifier (prefixed, e.g. prj_xxx).
params*pgbeam.GetProjectUsageParamsYesQuery parameters
params.StartDatestringYesStart date (inclusive, YYYY-MM-DD).
params.EndDatestringYesEnd date (inclusive, YYYY-MM-DD).

Response

(*pgbeam.ProjectUsageResponse, error) — daily usage data by region.

Example

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

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

result, err := client.Analytics.GetProjectUsage(ctx, "prj_xxx", &pgbeam.GetProjectUsageParams{
    StartDate: "...",
    EndDate: "...",
  })
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