Get review comment metrics for merged pull requests

curl --request GET \
  --url https://api.coderabbit.ai/v1/metrics/review-comments \
  --header 'x-coderabbitai-api-key: <api-key>'

const options = {method: 'GET', headers: {'x-coderabbitai-api-key': '<api-key>'}};

fetch('https://api.coderabbit.ai/v1/metrics/review-comments', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://api.coderabbit.ai/v1/metrics/review-comments",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "GET",
  CURLOPT_HTTPHEADER => [
    "x-coderabbitai-api-key: <api-key>"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"net/http"
	"io"
)

func main() {

	url := "https://api.coderabbit.ai/v1/metrics/review-comments"

	req, _ := http.NewRequest("GET", url, nil)

	req.Header.Add("x-coderabbitai-api-key", "<api-key>")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

require 'uri'
require 'net/http'

url = URI("https://api.coderabbit.ai/v1/metrics/review-comments")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Get.new(url)
request["x-coderabbitai-api-key"] = '<api-key>'

response = http.request(request)
puts response.read_body

{
  "data": [
    {
      "pr_url": "https://github.com/org/repo/pull/123",
      "organization_id": "<string>",
      "repository_id": "<string>",
      "author_id": "<string>",
      "merged_at": "2023-11-07T05:31:56Z",
      "coderabbit_comments": [
        {
          "url": "<string>",
          "severity": "critical",
          "category": "data_integrity_and_integration",
          "accepted": true
        }
      ]
    }
  ],
  "next_cursor": "<string>"
}

Review comment metrics

Returns JSON with one entry per merged pull request that has stored CodeRabbit review comment metrics. The inclusive UTC date window selects pull requests by merge date, regardless of when comments were posted. Pull requests without stored comments are excluded before pagination. Pagination is in write order rather than by merge date, so a pull request written after your cursor already passed its merge date (a backfill, or a reopen/reclose) still appears on a later page instead of being silently skipped. Each nested comment entry represents a stored finding; a comment URL may occur more than once when the posted comment contains multiple findings. Comment text is not returned. Unknown query parameters, including format and status, are rejected. Available on the Enterprise plan. Self-hosted CodeRabbit deployments can use this API when configured to send metrics to CodeRabbit Cloud. Requests include all organizations authorized by the API token unless narrowed by an organization selector.

GET

metrics

review-comments

Get review comment metrics for merged pull requests

curl --request GET \
  --url https://api.coderabbit.ai/v1/metrics/review-comments \
  --header 'x-coderabbitai-api-key: <api-key>'

const options = {method: 'GET', headers: {'x-coderabbitai-api-key': '<api-key>'}};

fetch('https://api.coderabbit.ai/v1/metrics/review-comments', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://api.coderabbit.ai/v1/metrics/review-comments",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "GET",
  CURLOPT_HTTPHEADER => [
    "x-coderabbitai-api-key: <api-key>"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"net/http"
	"io"
)

func main() {

	url := "https://api.coderabbit.ai/v1/metrics/review-comments"

	req, _ := http.NewRequest("GET", url, nil)

	req.Header.Add("x-coderabbitai-api-key", "<api-key>")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

require 'uri'
require 'net/http'

url = URI("https://api.coderabbit.ai/v1/metrics/review-comments")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Get.new(url)
request["x-coderabbitai-api-key"] = '<api-key>'

response = http.request(request)
puts response.read_body

{
  "data": [
    {
      "pr_url": "https://github.com/org/repo/pull/123",
      "organization_id": "<string>",
      "repository_id": "<string>",
      "author_id": "<string>",
      "merged_at": "2023-11-07T05:31:56Z",
      "coderabbit_comments": [
        {
          "url": "<string>",
          "severity": "critical",
          "category": "data_integrity_and_integration",
          "accepted": true
        }
      ]
    }
  ],
  "next_cursor": "<string>"
}

Use this endpoint for finding-level metadata. For pull-request-level aggregates, use the Metrics Data API. Self-hosted CodeRabbit deployments can use this API when configured to send metrics to CodeRabbit Cloud. Workspace API tokens include all authorized workspace organizations by default. Use org_id to select one provider organization. Instance-scoped API keys include authorized organizations in their Git provider instance. Organization-scoped API keys remain bound to their authenticated organization, including organizations connected to a self-hosted Git provider instance.

Authorizations

x-coderabbitai-api-key

string

header

required

API key for authentication. You can create an API key from the CodeRabbit dashboard.

Headers

x-coderabbitai-api-key

string

required

API key for authentication

Query Parameters

org_id

string

Workspace-scoped API tokens only. Selects one provider organization in the token's workspace. When omitted, includes all organizations authorized by the workspace token. Ignored for organization-scoped and Git-provider instance-scoped keys.

start_date

string<date>

required

Inclusive UTC merge date in YYYY-MM-DD format

Example:

"2026-09-01"

end_date

string<date>

required

Inclusive UTC merge date in YYYY-MM-DD format; must not precede start_date

Example:

"2026-09-09"

repository_ids

string

Comma-separated provider repository IDs. Maximum 10.

Example:

"1027529638,987654321"

user_ids

string

Comma-separated provider PR author IDs from stored PR metrics. Maximum 10.

Example:

"87397876,12345678"

organization_ids

string

Comma-separated provider organization IDs for self-hosted Git provider instance-scoped API keys. Maximum 10 input values. When omitted, includes all authorized organizations in the instance. The filter cannot expand the scope authorized by the API token. Not supported for organization-scoped or workspace-scoped API keys.

Example:

"184456712,103539130"

limit

integer

default:1000

Maximum number of pull requests per page, not the number of nested comments

Required range: 1 <= x <= 1000

cursor

string

Opaque next_cursor from the previous response. Keep the same date window and filters when fetching subsequent pages.

Response

Review comment metrics for eligible merged pull requests

data

object[]

required

Show child attributes

next_cursor

string | null

required

Opaque cursor for the next page; null when no more eligible pull requests remain

Repository Configuration

Subscription & billing

Connections

Dashboard

Reports

Organization administration

Enterprise SSO

Self-hosted CodeRabbit

CodeRabbit API

Review comment metrics

Authorizations

Headers

Query Parameters

Response