---
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 3 of 27 revisions.

- **2026-11-05** `3145f2078d68`: 1 breaking
- **2026-07-13** `ba27c6038636`: 4 breaking, 1 warning, 2 info
- **2026-01-05** `6b413429bbe5`: 12 info

## Changes

- **2026-11-05** `3145f2078d68`: 1 breaking
  - the `aggregations` request property's minItems was increased to `1`
- **2026-07-13** `ba27c6038636`: 4 breaking, 1 warning, 2 info
  - added the new required request property `metrics`
  - 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`
  - the request property `instances` became optional
  - added the required property `results` to the response with the `200` status
- **2026-01-05** `6b413429bbe5`: 12 info
  - added the new `connections_active` enum value to the request property `metric`
  - added the new `connections_idle` enum value to the request property `metric`
  - added the new `iops_read` enum value to the request property `metric`
  - added the new `iops_write` enum value to the request property `metric`
  - added the new `latency_read` enum value to the request property `metric`
  - added the new `latency_write` enum value to the request property `metric`
  - added the new `network_egress` enum value to the request property `metric`
  - added the new `network_ingress` enum value to the request property `metric`
  - added the new `replication_lag_time` enum value to the request property `metric`
  - added the new `throughput_read` enum value to the request property `metric`
  - added the new `throughput_write` enum value to the request property `metric`
  - added the new `wal_sync_time` enum value to the request property `metric`

---

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