Retrieve project consumption metrics

get

https://console.neon.tech/api/v2/consumption_history/v2/projects

Returns consumption metrics for up to limit projects per page. If project_ids is omitted, projects in the organization are included across pages (use cursor). If project_ids is provided, the response is limited to those projects (up to 100). Available for accounts on Launch, Scale, Agent, Business, and Enterprise plans.

History starts when the account upgrades to an eligible plan.

The metrics query parameter is required. Supported values: compute_unit_seconds, root_branch_bytes_month, child_branch_bytes_month, instant_restore_bytes_month, public_network_transfer_bytes, private_network_transfer_bytes, extra_branches_month, snapshot_storage_bytes_month.

Consumption metrics within each project are returned in ascending time order (oldest first). This request does not wake project computes.

Query Params

cursor

string

Cursor from the previous response (pagination.cursor). Pass it to fetch the next page of projects. Pages are ordered by project creation order (newest first).

limit

integer

1 to 100

Defaults to 10

Maximum number of projects per page. Allowed range: 1 to 100. Default: 10.

project_ids

array of strings

length between 0 and 100

Optional project IDs to filter the response (up to 100). If omitted, projects in the organization are included across pages (use cursor and limit).

Pass multiple IDs as repeated query parameters or a comma-separated list:

project_ids=cold-poetry-09157238&project_ids=quiet-snow-71788278
project_ids=cold-poetry-09157238,quiet-snow-71788278

project_ids

from

date-time

required

Specify the start date-time for the consumption period. The date-time value is rounded according to the specified granularity. For example, 2024-03-15T15:30:00Z for daily granularity will be rounded to 2024-03-15T00:00:00Z. The specified date-time value must respect the specified granularity:

For hourly, consumption metrics are limited to the last 168 hours.
For daily, consumption metrics are limited to the last 60 days.
For monthly, consumption metrics are limited to the last year.

The earliest allowed from value is March 1, 2024, at 00:00:00 UTC. Metrics are returned from when the account upgraded to an eligible plan, which may be later than that date.

date-time

required

Specify the end date-time for the consumption period. The date-time value is rounded according to the specified granularity. For example, 2024-03-15T15:30:00Z for daily granularity will be rounded to 2024-03-15T00:00:00Z. The specified date-time value must respect the specified granularity:

For hourly, consumption metrics are limited to the last 168 hours.
For daily, consumption metrics are limited to the last 60 days.
For monthly, consumption metrics are limited to the last year.

granularity

string

enum

required

Specify the granularity of consumption metrics. Hourly, daily, and monthly metrics are available for the last 168 hours, 60 days, and 1 year, respectively.

Allowed:

org_id

string

required

Organization ID. Metrics are returned for projects in this organization.

metrics

array of strings

required

Required. List the metrics to return. Supported values:

compute_unit_seconds
root_branch_bytes_month
child_branch_bytes_month
instant_restore_bytes_month
public_network_transfer_bytes
private_network_transfer_bytes
extra_branches_month
snapshot_storage_bytes_month

Pass multiple values as repeated query parameters or a comma-separated list:

metrics=compute_unit_seconds&metrics=extra_branches_month
metrics=compute_unit_seconds,extra_branches_month

metrics*

Responses

200Project consumption metrics for the Neon account.

403Not available for this account. Project consumption history requires a Launch, Scale, Agent, Business, or Enterprise plan.

404Account is not a member of the organization specified by org_id.

406The from and to range is not valid for the selected granularity. Adjust the range or choose a different granularity.

429Too many requests