Documentation Index

Fetch the complete documentation index at: /llms.txt

Use this file to discover all available pages before exploring further.

Skip to main content
GET
/
v1
/
metrics
/
reviews
cURL
curl --request GET \
  --url 'https://api.coderabbit.ai/v1/metrics/reviews?start_date=2026-01-01&end_date=2026-01-20' \
  --header 'x-coderabbitai-api-key: <api-key>'
import requests

url = 'https://api.coderabbit.ai/v1/metrics/reviews'

headers = {'x-coderabbitai-api-key': '<api-key>'}

params = {'start_date': '2026-01-01', 'end_date': '2026-01-20'}

response = requests.get(url, headers=headers, params=params)

print(response.text)
const options = {method: 'GET', headers: {'x-coderabbitai-api-key': '<api-key>'}};

fetch('https://api.coderabbit.ai/v1/metrics/reviews?start_date=2026-01-01&end_date=2026-01-20', 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/reviews?start_date=2026-01-01&end_date=2026-01-20',
  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/reviews?start_date=2026-01-01&end_date=2026-01-20"

	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))

}
HttpResponse<String> response = Unirest.get("https://api.coderabbit.ai/v1/metrics/reviews?start_date=2026-01-01&end_date=2026-01-20")
  .header("x-coderabbitai-api-key", "<api-key>")
  .asString();
require 'uri'
require 'net/http'

url = URI("https://api.coderabbit.ai/v1/metrics/reviews?start_date=2026-01-01&end_date=2026-01-20")

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": "<string>",
      "author_id": "<string>",
      "author_username": "<string>",
      "organization_id": "<string>",
      "organization_name": "<string>",
      "repository_id": "<string>",
      "repository_name": "<string>",
      "created_at": "2023-11-07T05:31:56Z",
      "ready_for_review_at": "2023-11-07T05:31:56Z",
      "first_human_review_at": "2023-11-07T05:31:56Z",
      "last_commit_at": "2023-11-07T05:31:56Z",
      "merged_at": "2023-11-07T05:31:56Z",
      "estimated_complexity": 123,
      "estimated_review_minutes": 123,
      "coderabbit_comments": {
        "total": {
          "posted": 123,
          "accepted": 123
        },
        "severity": {
          "critical": {
            "posted": 123,
            "accepted": 123
          },
          "major": {
            "posted": 123,
            "accepted": 123
          },
          "minor": {
            "posted": 123,
            "accepted": 123
          },
          "trivial": {
            "posted": 123,
            "accepted": 123
          },
          "info": {
            "posted": 123,
            "accepted": 123
          }
        },
        "category": {
          "security_and_privacy": {
            "posted": 123,
            "accepted": 123
          },
          "performance_and_scalability": {
            "posted": 123,
            "accepted": 123
          },
          "functional_correctness": {
            "posted": 123,
            "accepted": 123
          },
          "maintainability_and_code_quality": {
            "posted": 123,
            "accepted": 123
          },
          "data_integrity_and_integration": {
            "posted": 123,
            "accepted": 123
          },
          "stability_and_availability": {
            "posted": 123,
            "accepted": 123
          }
        }
      }
    }
  ],
  "next_cursor": "<string>"
}
{
  "errors": [
    {
      "code": "INVALID_PARAMETER",
      "message": "start_date: start_date is required"
    }
  ]
}
{
  "message": "Invalid or missing API key",
  "code": "UNAUTHORIZED"
}
{
  "message": "API access requires an Enterprise plan subscription",
  "code": "FORBIDDEN"
}
{
  "message": "Response exceeds maximum size of 16MB. Please use a smaller date range or add filters.",
  "code": "RESPONSE_TOO_LARGE"
}
{
  "message": "Rate limit exceeded. Please retry after 60 seconds.",
  "code": "RATE_LIMITED"
}
Returns metrics for merged pull requests including complexity scores, review times, and comment breakdowns by severity and category.

CSV Format

When using format=csv, the API returns a flat CSV structure with one row per pull request. The nested coderabbit_comments object is flattened into individual columns (e.g., total_coderabbit_comments_posted, critical_comments_accepted). For the complete list of CSV columns and field descriptions, see Data Export - Exported fields.

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

Your CodeRabbit API key

Query Parameters

start_date
string<date>
required

Start date in ISO 8601 format (YYYY-MM-DD)

end_date
string<date>
required

End date in ISO 8601 format (YYYY-MM-DD)

organization_ids
string

Filter by organization Git provider IDs (comma-separated, max 10). Self-hosted instances only.

repository_ids
string

Filter by repository Git provider IDs (comma-separated, max 10).

user_ids
string

Filter by author Git provider IDs (comma-separated, max 10).

format
enum<string>
default:json

Response format

Available options:
json,
csv
limit
integer
default:1000

Maximum records to return

cursor
string

Pagination cursor for fetching next page of results

Response

Successful response

data
object[]
required
next_cursor
string

Cursor for fetching the next page of results. Not present if no more results.

Morty Proxy This is a proxified and sanitized view of the page, visit original site.