---
title: "Changes to Retrieve branch metrics"
method: POST
path: "/organizations/{organizationID}/projects/{projectID}/branches/{branchID}/metrics"
---

# Changes to Retrieve branch metrics

`POST /organizations/{organizationID}/projects/{projectID}/branches/{branchID}/metrics`

> Every recorded change to this operation, newest first.

## Timeline

Changed in 4 of 68 revisions.

- **2026-11-04** `4bc5ad58a6c6`: 1 breaking
- **2026-05-27** `8d02eb2c8759`: 4 breaking, 1 warning
- **2026-05-26** `f5b0c7bc81f8`: 17 breaking, 8 info
- **2026-04-15** `a2cc5189d200`: 3 breaking, 1 warning, 3 info

## Changes

- **2026-11-04** `4bc5ad58a6c6`: 1 breaking
  - the `aggregations` request property's minItems was increased to `1`
- **2026-05-27** `8d02eb2c8759`: 4 breaking, 1 warning
  - the request property `metrics` became required
  - removed the required property `metric` from the response with the `200` status
  - removed the required property `series` from the response with the `200` status
  - removed the required property `unit` from the response with the `200` status
  - removed the request property `metric`
- **2026-05-26** `f5b0c7bc81f8`: 17 breaking, 8 info
  - added `#/components/schemas/BranchMetricName` to the `metric` request property `allOf` list
  - removed the enum value `connections_active` of the request property `metric`
  - removed the enum value `connections_idle` of the request property `metric`
  - removed the enum value `cpu` of the request property `metric`
  - removed the enum value `disk` of the request property `metric`
  - removed the enum value `iops_read` of the request property `metric`
  - removed the enum value `iops_write` of the request property `metric`
  - removed the enum value `latency_read` of the request property `metric`
  - removed the enum value `latency_write` of the request property `metric`
  - removed the enum value `memory` of the request property `metric`
  - removed the enum value `network_egress` of the request property `metric`
  - removed the enum value `network_ingress` of the request property `metric`
  - removed the enum value `replication_lag_time` of the request property `metric`
  - removed the enum value `throughput_read` of the request property `metric`
  - removed the enum value `throughput_write` of the request property `metric`
  - removed the enum value `wal_sync_time` of the request property `metric`
  - the `metric` request property type changed from `string` to no type
  - added the new optional request property `metrics`
  - the request property `instances` became optional
  - the request property `metric` became optional
  - request property `metric` deprecated
  - response property `metric` deprecated
  - response property `series` deprecated
  - response property `unit` deprecated
  - added the required property `results` to the response with the `200` status
- **2026-04-15** `a2cc5189d200`: 3 breaking, 1 warning, 3 info
  - added the new required request property `metric`
  - the request property `instances` became required
  - removed the required property `results` from the response with the `200` status
  - removed the request property `metrics`
  - added the required property `metric` to the response with the `200` status
  - added the required property `series` to the response with the `200` status
  - added the required property `unit` to the response with the `200` status

---

[Operation](https://skmtc.dev/xataio/apis/xata-api/docs/organizations/:organizationID/projects/:projectID/branches/:branchID/metrics/post.md) - [API](https://skmtc.dev/xataio/apis/xata-api.md) - [Page](https://skmtc.dev/xataio/apis/xata-api/changes/organizations/:organizationID/projects/:projectID/branches/:branchID/metrics/post)