Skip to main content
GET
Get review comment metrics for merged pull requests
| Use this endpoint for finding-level metadata. Results include each finding’s severity, category, stored resolution outcome, and comment URL without returning comment text. For pull-request-level aggregates, use the Metrics Data API. Workspace API tokens can use org_id to select one provider organization. If org_id does not match an active organization in the workspace, the request returns 404. If the workspace scope resolves to zero or multiple organizations, the request returns 403. Organization-scoped API keys ignore this parameter.

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. The resolved scope must contain exactly one organization; a multi-organization scope returns 403. 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 instances connected to CodeRabbit Cloud. Maximum 10 input values; the resolved scope must contain exactly one organization. Not supported for organizations without a self-hosted Git provider instance.

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
next_cursor
string | null
required

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