Skip to content
Everruns Cloud is open in early access. Run agents without operating the platform.

Usage and cost reporting: queries, saved reports, catalog.

CommandWhat it does
reports admin backfillEnqueue missing reporting projection work from canonical sources.
reports admin diagnostics getInspect reporting projector lag and failed outbox rows.
reports catalog getReturn semantic reporting datasets, dimensions, measures, and filter fields.
reports projector runClaim and process pending reporting outbox rows.
reports query exportRun and export an org-scoped semantic reporting query.
reports query runRun an org-scoped semantic reporting query.
reports saved createCreate an org-scoped saved report definition.
reports saved deleteDelete an org-scoped saved report definition.
reports saved exportRun and export an org-scoped saved report definition.
reports saved getGet an org-scoped saved report definition.
reports saved listList org-scoped saved report definitions.
reports saved runRun an org-scoped saved report definition.
reports saved updateUpdate an org-scoped saved report definition.

Enqueue missing reporting projection work from canonical sources.

Terminal window
everruns reports admin backfill [OPTIONS]
FlagDescription
--limit <LIMIT>Maximum number of outbox rows to enqueue across all source types.

Example:

Terminal window
# Rebuild reporting data that is missing from older sessions
everruns reports admin backfill --limit 1000 --reason 'Reports are missing last week'

Inspect reporting projector lag and failed outbox rows.

Terminal window
everruns reports admin diagnostics get [OPTIONS]

Example:

Terminal window
# Check whether reporting is lagging behind live data
everruns reports admin diagnostics get

Return semantic reporting datasets, dimensions, measures, and filter fields.

Terminal window
everruns reports catalog get [OPTIONS]

Example:

Terminal window
# Discover the datasets, dimensions and measures a query can use
everruns reports catalog get

Claim and process pending reporting outbox rows.

Terminal window
everruns reports projector run [OPTIONS]
FlagDescription
--limit <LIMIT>Maximum number of items returned in this page.

Example:

Terminal window
# Process pending reporting rows right away when reports look stale
everruns reports projector run --limit 500 --reason 'Reports lag behind live data'

Run and export an org-scoped semantic reporting query.

Terminal window
everruns reports query export [OPTIONS] --query <query>
FlagDescription
--format <FORMAT>Output format for a report export. One of csv, json.
--query <QUERY>Required. Semantic query a caller submits to the reporting layer.

Example:

Terminal window
# Download a one-off query result as CSV
everruns reports query export --format csv --query '{"dataset":"sessions","time_range":{"from":"2026-04-01T00:00:00Z","to":"2026-05-01T00:00:00Z"},"dimensions":["status"],"measures":["session_count"],"filters":[],"order_by":[],"limit":100}'

Run an org-scoped semantic reporting query.

Terminal window
everruns reports query run [OPTIONS] --dataset <dataset> --time-range <time_range>
FlagDescription
--dataset <DATASET>Required. Dataset name to query (see GET /v1/reports/catalog for the list of available datasets).
--dimensions <DIMENSIONS>Columns to group by. Repeatable.
--filters <FILTERS>Predicate filters applied before aggregation.
--limit <LIMIT>Maximum number of rows to return (defaults to 100).
--measures <MEASURES>Aggregations to compute (count, sum, avg, etc.). Repeatable.
--order-by <ORDER_BY>Sort spec applied after aggregation.
--time-range <TIME_RANGE>Required. Half-open time window applied to the dataset’s primary timestamp column during a report query.

Example:

Terminal window
# Answer a quick question, such as sessions per status last month
everruns reports query run --dataset sessions --time-range '{"from":"2026-04-01T00:00:00Z","to":"2026-05-01T00:00:00Z"}' --dimensions status --measures session_count

Create an org-scoped saved report definition.

Terminal window
everruns reports saved create [OPTIONS] --name <name> --query <query>
FlagDescription
--dashboard <DASHBOARD>
--description <DESCRIPTION>Human-readable description.
--name <NAME>Required. Human-readable name.
--query <QUERY>Required. Semantic query a caller submits to the reporting layer.

Example:

Terminal window
# Save a query so the team can rerun it
everruns reports saved create --name 'Sessions by status' --query '{"dataset":"sessions","time_range":{"from":"2026-04-01T00:00:00Z","to":"2026-05-01T00:00:00Z"},"dimensions":["status"],"measures":["session_count"],"filters":[],"order_by":[],"limit":100}' --reason 'Monthly review'

Delete an org-scoped saved report definition.

Terminal window
everruns reports saved delete [OPTIONS] --report-id <report_id>
FlagDescription
--report-id <REPORT_ID>Required. Saved report’s prefixed public identifier.

Example:

Terminal window
# Delete a saved report nobody uses
everruns reports saved delete --report-id 0190f8a2-7c1e-7d3a-9b2f-4e5d6c7b8a90 --reason 'Superseded by the weekly report'

Run and export an org-scoped saved report definition.

Terminal window
everruns reports saved export [OPTIONS] --report-id <report_id> --request <request>
FlagDescription
--report-id <REPORT_ID>Required. Saved report’s prefixed public identifier.
--request <REQUEST>Required. Request body for the export_saved_report operation.

Example:

Terminal window
# Download a saved report's current data as JSON
everruns reports saved export --report-id 0190f8a2-7c1e-7d3a-9b2f-4e5d6c7b8a90 --request '{"format":"json"}'

Get an org-scoped saved report definition.

Terminal window
everruns reports saved get [OPTIONS] --report-id <report_id>
FlagDescription
--report-id <REPORT_ID>Required. Saved report’s prefixed public identifier.

Example:

Terminal window
# Read a saved report's query before changing or running it
everruns reports saved get --report-id 0190f8a2-7c1e-7d3a-9b2f-4e5d6c7b8a90

List org-scoped saved report definitions.

Terminal window
everruns reports saved list [OPTIONS]

Example:

Terminal window
# Find a saved report's id
everruns reports saved list

Run an org-scoped saved report definition.

Terminal window
everruns reports saved run [OPTIONS] --report-id <report_id>
FlagDescription
--report-id <REPORT_ID>Required. Saved report’s prefixed public identifier.

Example:

Terminal window
# Get the current numbers for a saved report
everruns reports saved run --report-id 0190f8a2-7c1e-7d3a-9b2f-4e5d6c7b8a90

Update an org-scoped saved report definition.

Terminal window
everruns reports saved update [OPTIONS] --report-id <report_id> --request <request>
FlagDescription
--report-id <REPORT_ID>Required. Saved report’s prefixed public identifier.
--request <REQUEST>Required. Request body for the update_saved_report operation.

Example:

Terminal window
# Rename a saved report
everruns reports saved update --report-id 0190f8a2-7c1e-7d3a-9b2f-4e5d6c7b8a90 --request '{"name":"Weekly active agents"}' --reason 'Clearer name'