/consumption_history/projectsRetrieve project consumption metrics (legacy plans)
Retrieves consumption metrics for Scale, Business, and Enterprise plan projects. History begins at the time of upgrade. Results are ordered by time in ascending order (oldest to newest). Issuing a call to this API does not wake a project's compute endpoint.
Quick start
curl "https://console.neon.tech/api/v2/consumption_history/projects?from=$FROM&to=$TO&granularity=$GRANULARITY" \
-H "Authorization: Bearer $NEON_API_KEY"Every field below is optional. An empty body works too.
import { createNeonClient, raw } from '@neon/sdk';
const neon = createNeonClient({ apiKey: process.env.NEON_API_KEY });
const { data } = await raw.getConsumptionHistoryPerProject({
client: neon.client,
query: {
from: process.env.FROM,
to: process.env.TO,
granularity: process.env.GRANULARITY
}
});Parameters
cursorSpecify the cursor value from the previous response to get the next batch of projects.
limitSpecify a value from 1 to 100 to limit number of projects in the response.
project_idsSpecify a list of project IDs to filter the response. If omitted, the response will contain all projects. A list of project IDs can be specified as an array of parameter values or as a comma-separated list in a single parameter value.
- As an array of parameter values:
project_ids=cold-poetry-09157238%20&project_ids=quiet-snow-71788278 - As a comma-separated list in a single parameter value:
project_ids=cold-poetry-09157238,quiet-snow-71788278
fromSpecify 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 consumption history is available starting from March 1, 2024, at 00:00:00 UTC.
toSpecify 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.
granularitySpecify the granularity of consumption metrics. Hourly, daily, and monthly metrics are available for the last 168 hours, 60 days, and 1 year, respectively.
org_idSpecify the organization for which the project consumption metrics should be returned. If this parameter is not provided, the endpoint will return the metrics for the authenticated user's projects.
include_v1_metricsThe field is deprecated. Please use metrics instead.
If metrics is specified, this field is ignored.
Include metrics utilized in previous pricing models.
- data_storage_bytes_hour: The sum of the maximum observed storage values for each hour, which never decreases.
metricsSpecify a list of metrics to include in the response. If omitted, active_time, compute_time, written_data, synthetic_storage_size are returned. Possible values:
active_time_secondscompute_time_secondswritten_data_bytessynthetic_storage_size_bytesdata_storage_bytes_hourlogical_size_byteslogical_size_bytes_hour
A list of metrics can be specified as an array of parameter values or as a comma-separated list in a single parameter value.
- As an array of parameter values:
metrics=cpu_seconds&metrics=ram_bytes - As a comma-separated list in a single parameter value:
metrics=cpu_seconds,ram_bytes
Response
200Returned project consumption metrics for the Neon account
Errors
This endpoint is not available. It is only supported with Scale, Business, and Enterprise plan accounts.
Account is not a member of the organization specified by org_id.
The specified date-time range is outside the boundaries of the specified granularity.
Adjust your from and to values or select a different granularity.
Too many requests
General error
This endpoint can return the standard Neon API error response.
Response fields
messageRequired. Human-readable error message.codeRequired. Machine-readable error code.request_idOptional. Request identifier for debugging. You can provide one with theX-Request-IDheader.
Retry guidance
If no response is returned, the request may still have reached the server. This is why retry safety depends on the method and status code.
Idempotent methods (GET, HEAD, OPTIONS) are generally safe to retry after a network error or timeout. Non-idempotent methods (POST, PATCH, DELETE, PUT) can change state, so avoid automatic retries unless your workflow can tolerate duplicate effects.
Responses with 423 Locked or 503 Service Unavailable are safe to retry. 423 Locked means the resource is temporarily locked, usually because another operation is in progress.