Skip to main content
GET
Get review comment metrics for merged pull requests
To install and sign in to the CLI, see Call from the CLI.

Authorizations

x-coderabbitai-api-key
string
header
required

See Authentication for the key types and where to create a key.

Query Parameters

org_name
string

GitHub organization login for a workspace API key, matched case-insensitively within that workspace. Supply either org_name or org_id, never both; omit for an organization-bound key.

Pattern: ^[A-Za-z0-9][A-Za-z0-9-]{0,38}$
org_id
string

Workspace-scoped API tokens only. Supply this provider organization ID or org_name, never both, to select one organization in the workspace. When both selectors are omitted, includes all organizations authorized by the workspace token. This org_id parameter is 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
next_cursor
string | null
required

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