PgBeam Docs
projects

projects usage

Show project usage

Display usage metrics for the linked project over a date range. Shows daily breakdowns of total queries, cache hits, and data transferred by region. Defaults to the current calendar month if no date range is specified.

Usage

pgbeam projects usage [flags]

Options

OptionDescriptionRequiredDefault
--start-date <value>Start of the date range in YYYY-MM-DD format. Defaults to the first day of the current month.No-
--end-date <value>End of the date range in YYYY-MM-DD format. Defaults to today.No-

Global options

All global options (--token, --profile, --project, --org, --json, --no-color, --debug) are also available on this command.

Examples

# Show usage for the current month
pgbeam projects usage

# Show usage for a specific date range
pgbeam projects usage --start-date 2025-01-01 --end-date 2025-01-31

# Get usage data as JSON for further processing
pgbeam projects usage --json

Output

Displays total queries and data transferred, followed by a day-by-day table with columns: Day, Region, Queries, Cache Hits, and Data. With --json, returns the full usage response from the API.

On this page