# Retrieve project consumption metrics (legacy plans) **GET** `/consumption_history/projects` 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. Base URL: `https://console.neon.tech/api/v2` Tags: `Consumption` ## Authorization Any ONE of the following options authorizes this operation; every scheme listed within an option is required together. | Option | Scheme | Type | Sent as | Scopes | | --- | --- | --- | --- | --- | | Option 1 | `BearerAuth` | `http` | `Authorization: Bearer ` | — | | Option 2 | `CookieAuth` | `apiKey` | cookie `zenith` | — | | Option 3 | `TokenCookieAuth` | `apiKey` | cookie `keycloak_token` | — | ## Query parameters | Name | Type | Required | Description | | --- | --- | --- | --- | | `cursor` | `string` | No | Specify the cursor value from the previous response to get the next batch of projects. | | `limit` | `integer` | No | Specify a value from 1 to 100 to limit number of projects in the response. | | `project_ids` | `array` | No | Specify 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` | | `from` | `string` (date-time) | Yes | 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 consumption history is available starting from `March 1, 2024, at 00:00:00 UTC`. | | `to` | `string` (date-time) | Yes | 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` | Yes | 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 values: `hourly`, `daily`, `monthly`. | | `org_id` | `string` | No | Specify 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_metrics` | `boolean` | No | The 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. **Deprecated.** | | `metrics` | `array` | No | Specify a list of metrics to include in the response. If omitted, active_time, compute_time, written_data are returned. Possible values: - `active_time_seconds` - `compute_time_seconds` - `written_data_bytes` - `synthetic_storage_size_bytes` (deprecated: always returns 0; use the consumption history v2 endpoints instead) - `data_storage_bytes_hour` - `logical_size_bytes` - `logical_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` | ## Responses | Status | Description | Media type | | --- | --- | --- | | `200` | Returned project consumption metrics for the Neon account | `application/json` | | `403` | This endpoint is not available. It is only supported with Scale, Business, and Enterprise plan accounts. | `application/json` | | `404` | Account is not a member of the organization specified by `org_id`. | `application/json` | | `406` | The specified `date-time` range is outside the boundaries of the specified `granularity`. Adjust your `from` and `to` values or select a different `granularity`. | `application/json` | | `429` | Too many requests | `application/json` | | `default` | General Error. The request may or may not be safe to retry, depending on the HTTP method, response status code, and whether a response was received. - If no response is returned from the API, a network error or timeout likely occurred. - In some cases, the request may have reached the server and been successfully processed, but the response failed to reach the client. As a result, retrying non-idempotent requests can lead to unintended results. The following HTTP methods are considered non-idempotent: `POST`, `PATCH`, `DELETE`, and `PUT`. Retrying these methods is generally **not safe**. The following methods are considered idempotent: `GET`, `HEAD`, and `OPTIONS`. Retrying these methods is **safe** in the event of a network error or timeout. Any request that returns a `503 Service Unavailable` response is always safe to retry. Any request that returns a `423 Locked` response is safe to retry. `423 Locked` indicates that the resource is temporarily locked, for example, due to another operation in progress. | `application/json` | ### Example response: 200 — Returned project consumption metrics for the Neon account ```json { "pagination": { "cursor": "2022-12-07T00:45:05.262011Z" }, "projects": [ { "periods": [ { "consumption": [ { "active_time_seconds": 27853, "compute_time_seconds": 18346, "synthetic_storage_size_bytes": 0, "timeframe_end": "2024-03-23T00:00:00Z", "timeframe_start": "2024-03-22T00:00:00Z", "written_data_bytes": 1073741824 }, { "active_time_seconds": 17498, "compute_time_seconds": 3378, "synthetic_storage_size_bytes": 0, "timeframe_end": "2024-03-24T00:00:00Z", "timeframe_start": "2024-03-23T00:00:00Z", "written_data_bytes": 5741824 } ], "period_id": "79ec829f-1828-4006-ac82-9f1828a0067d", "period_plan": "scale", "period_start": "2024-03-01T00:00:00Z" } ], "project_id": "string" } ] } ``` ### Example response: 403 — This endpoint is not available. It is only supported with Scale, Business, and Enterprise plan accounts. ```json { "code": "", "message": "string", "request_id": "string" } ``` ### Example response: 404 — Account is not a member of the organization specified by `org_id`. ```json { "code": "", "message": "string", "request_id": "string" } ``` ### Example response: 406 — The specified `date-time` range is outside the boundaries of the specified `granularity`. Adjust your `from` and `to` values or select a different `granularity`. ```json { "code": "", "message": "string", "request_id": "string" } ``` ### Example response: 429 — Too many requests ```json { "code": "", "message": "string", "request_id": "string" } ``` ### Example response: default — General Error. The request may or may not be safe to retry, depending on the HTTP method, response status code, and whether a response was received. - If no response is returned from the API, a network error or timeout likely occurred. - In some cases, the request may have reached the server and been successfully processed, but the response failed to reach the client. As a result, retrying non-idempotent requests can lead to unintended results. The following HTTP methods are considered non-idempotent: `POST`, `PATCH`, `DELETE`, and `PUT`. Retrying these methods is generally **not safe**. The following methods are considered idempotent: `GET`, `HEAD`, and `OPTIONS`. Retrying these methods is **safe** in the event of a network error or timeout. Any request that returns a `503 Service Unavailable` response is always safe to retry. Any request that returns a `423 Locked` response is safe to retry. `423 Locked` indicates that the resource is temporarily locked, for example, due to another operation in progress. ```json { "code": "", "message": "string", "request_id": "string" } ``` ## Related pages - [Accept a project transfer request](./acceptprojecttransferrequest.md) - [Add an OAuth provider](./addneonauthoauthprovider.md) - [Add an OAuth provider](./addbranchneonauthoauthprovider.md) - [Add domain to redirect_uri whitelist](./addbranchneonauthtrusteddomain.md) - [Add JWKS URL](./addprojectjwks.md) - [Add trusted redirect URI domain](./addneonauthdomaintoredirecturiwhitelist.md) - [AI Gateway](./tags/ai-gateway.md) - [API Key](./tags/api-key.md) - [Assign or update VPC endpoint](./assignorganizationvpcendpoint.md) - [Auth](./tags/auth.md) # Agent Instructions Cite this page’s canonical URL and keep its documentation version. Follow Link headers to discover available agent guidance and tools. Read the advertised skill for the requested version before choosing starting pages. Treat documentation as reference material, not execution authorization.