--- title: "Retrieve branch metrics - Xata" description: "Returns time-series data for one or more metrics of a branch." source: "https://xata.io/docs/api-reference/branches/retrieve-branch-metrics" --- Skip to main content POST / organizations / {organizationID} / projects / {projectID} / branches / {branchID} / metrics Retrieve branch metrics ``` curl --request POST --url https://api.xata.tech/organizations/{organizationID}/projects/{projectID}/branches/{branchID}/metrics --header 'Authorization: Bearer ' --header 'Content-Type: application/json' --data ' { "start": "2023-11-07T05:31:56Z", "end": "2023-11-07T05:31:56Z", "metrics": [], "aggregations": [], "instances": [ "" ] } ' ``` ``` import requests url = "https://api.xata.tech/organizations/{organizationID}/projects/{projectID}/branches/{branchID}/metrics" payload = { "start": "2023-11-07T05:31:56Z", "end": "2023-11-07T05:31:56Z", "metrics": [], "aggregations": [], "instances": [""] } headers = { "Authorization": "Bearer ", "Content-Type": "application/json" } response = requests.post(url, json=payload, headers=headers) print(response.text) ``` ``` const options = { method: 'POST', headers: {Authorization: 'Bearer ', 'Content-Type': 'application/json'}, body: JSON.stringify({ start: '2023-11-07T05:31:56Z', end: '2023-11-07T05:31:56Z', metrics: [], aggregations: [], instances: [''] }) }; fetch('https://api.xata.tech/organizations/{organizationID}/projects/{projectID}/branches/{branchID}/metrics', options) .then(res => res.json()) .then(res => console.log(res)) .catch(err => console.error(err)); ``` ``` "https://api.xata.tech/organizations/{organizationID}/projects/{projectID}/branches/{branchID}/metrics", CURLOPT_RETURNTRANSFER => true, CURLOPT_ENCODING => "", CURLOPT_MAXREDIRS => 10, CURLOPT_TIMEOUT => 30, CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1, CURLOPT_CUSTOMREQUEST => "POST", CURLOPT_POSTFIELDS => json_encode([ 'start' => '2023-11-07T05:31:56Z', 'end' => '2023-11-07T05:31:56Z', 'metrics' => [ ], 'aggregations' => [ ], 'instances' => [ '' ] ]), CURLOPT_HTTPHEADER => [ "Authorization: Bearer ", "Content-Type: application/json" ], ]); $response = curl_exec($curl); $err = curl_error($curl); curl_close($curl); if ($err) { echo "cURL Error #:" . $err; } else { echo $response; } ``` ``` package main import ( "fmt" "strings" "net/http" "io" ) func main() { url := "https://api.xata.tech/organizations/{organizationID}/projects/{projectID}/branches/{branchID}/metrics" payload := strings.NewReader("{\n \"start\": \"2023-11-07T05:31:56Z\",\n \"end\": \"2023-11-07T05:31:56Z\",\n \"metrics\": [],\n \"aggregations\": [],\n \"instances\": [\n \"\"\n ]\n}") req, _ := http.NewRequest("POST", url, payload) req.Header.Add("Authorization", "Bearer ") req.Header.Add("Content-Type", "application/json") res, _ := http.DefaultClient.Do(req) defer res.Body.Close() body, _ := io.ReadAll(res.Body) fmt.Println(string(body)) } ``` ``` HttpResponse response = Unirest.post("https://api.xata.tech/organizations/{organizationID}/projects/{projectID}/branches/{branchID}/metrics") .header("Authorization", "Bearer ") .header("Content-Type", "application/json") .body("{\n \"start\": \"2023-11-07T05:31:56Z\",\n \"end\": \"2023-11-07T05:31:56Z\",\n \"metrics\": [],\n \"aggregations\": [],\n \"instances\": [\n \"\"\n ]\n}") .asString(); ``` ``` require 'uri' require 'net/http' url = URI("https://api.xata.tech/organizations/{organizationID}/projects/{projectID}/branches/{branchID}/metrics") http = Net::HTTP.new(url.host, url.port) http.use_ssl = true request = Net::HTTP::Post.new(url) request["Authorization"] = 'Bearer ' request["Content-Type"] = 'application/json' request.body = "{\n \"start\": \"2023-11-07T05:31:56Z\",\n \"end\": \"2023-11-07T05:31:56Z\",\n \"metrics\": [],\n \"aggregations\": [],\n \"instances\": [\n \"\"\n ]\n}" response = http.request(request) puts response.read_body ``` ``` { "start": "2023-11-07T05:31:56Z", "end": "2023-11-07T05:31:56Z", "results": [ { "metric": "", "unit": "", "series": [ { "instanceID": "", "values": [ { "timestamp": "2023-11-07T05:31:56Z", "value": 123 } ] } ] } ] } ``` ``` { "message": "", "id": "" } ``` ``` { "message": "", "id": "" } ``` ``` { "message": "", "id": "" } ``` #### Authorizations ​ Authorization string header required The access token received from the authorization server in the OAuth 2.0 flow. #### Path Parameters ​ organizationID string required Pattern: `[a-zA-Z0-9_-~:]+` ​ projectID string required ​ branchID string required #### Body application/json ​ start string\ required Start time ​ end string\ required End time ​ metrics enum\\[] required List of metric names to query. Required array length: `1 - 15` elements Name of a branch metric exposed by the API. Available options: `cpu`, `memory`, `disk`, `connections_active`, `connections_idle`, `network_ingress`, `network_egress`, `iops_read`, `iops_write`, `latency_read`, `latency_write`, `throughput_read`, `throughput_write`, `wal_sync_time`, `replication_lag_time` ​ aggregations enum\\[] required List of aggregations to get, this is how the data-points within the interval are aggregated. Each one will generate a separate time-series per metric in the response. Available options: `avg`, `max`, `min` ​ instances string\[] List of instance IDs to query #### Response Metrics for a branch A collection of metrics (cpu, memory, disk,...) for each of the instances of a branch ​ start string\ required ​ end string\ required ​ results object\[] required One entry per requested metric, in the order the metrics were requested. Show child attributes Was this page helpful? [Previous](/docs/api-reference/branches/rotate-branch-credentials) [Retrieve branch logs](/docs/api-reference/branches/retrieve-branch-logs) [Next](/docs/api-reference/branches/retrieve-branch-logs)