Read a Verify bug's observed history
curl --request GET \
--url https://api.coderabbit.ai/v1/verify/repositories/{repository_id}/bugs/{bug_id}/history \
--header 'x-coderabbitai-api-key: <api-key>'import requests
url = "https://api.coderabbit.ai/v1/verify/repositories/{repository_id}/bugs/{bug_id}/history"
headers = {"x-coderabbitai-api-key": "<api-key>"}
response = requests.get(url, headers=headers)
print(response.text)const options = {method: 'GET', headers: {'x-coderabbitai-api-key': '<api-key>'}};
fetch('https://api.coderabbit.ai/v1/verify/repositories/{repository_id}/bugs/{bug_id}/history', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));{
"total": 123,
"next_cursor": "<string>",
"affected_run_count": 123,
"observations": [
{
"observation_id": "<string>",
"bug_id": "<string>",
"execution_id": "<string>",
"cuj_id": "<string>",
"bug": {
"title": "<string>",
"description": "<string>",
"reproductionSteps": [
"<string>"
],
"expectedBehavior": "<string>",
"actualBehavior": "<string>",
"evidenceArtifactIds": [
"<string>"
]
},
"payload_unavailable": true,
"job_id": "<string>",
"source": "<string>",
"run_id": "<string>",
"run_started_at": "<string>",
"pull_request_number": 123,
"repository_registration_id": "<string>",
"branch": "<string>",
"environment_id": "<string>",
"head_sha": "<string>",
"occurred_at": "<string>",
"scenario_title": "<string>"
}
]
}{
"error": {
"code": "invalid_request",
"message": "<string>",
"retry_after": 1
}
}{
"error": {
"code": "unauthenticated",
"message": "<string>",
"retry_after": 1
}
}{
"error": {
"code": "forbidden",
"message": "<string>",
"retry_after": 1
}
}{
"error": {
"code": "not_found",
"message": "<string>",
"retry_after": 1
}
}{
"error": {
"code": "head_changed",
"message": "<string>",
"retry_after": 1
}
}{
"error": {
"code": "precondition_failed",
"message": "<string>",
"retry_after": 1
}
}{
"error": {
"code": "payload_too_large",
"message": "<string>",
"retry_after": 1
}
}{
"error": {
"code": "rate_limit_exceeded",
"message": "<string>",
"retry_after": 1
}
}{
"error": {
"code": "internal_error",
"message": "<string>",
"retry_after": 1
}
}{
"error": {
"code": "unavailable",
"message": "<string>",
"retry_after": 1
}
}Read a Verify bug's observed history
Lists observations of one canonical Verify bug across jobs, with run, branch, pull request and head SHA details. Follow next_cursor to read more pages; total and affected_run_count cover the full history.
GET
/
v1
/
verify
/
repositories
/
{repository_id}
/
bugs
/
{bug_id}
/
history
Read a Verify bug's observed history
curl --request GET \
--url https://api.coderabbit.ai/v1/verify/repositories/{repository_id}/bugs/{bug_id}/history \
--header 'x-coderabbitai-api-key: <api-key>'import requests
url = "https://api.coderabbit.ai/v1/verify/repositories/{repository_id}/bugs/{bug_id}/history"
headers = {"x-coderabbitai-api-key": "<api-key>"}
response = requests.get(url, headers=headers)
print(response.text)const options = {method: 'GET', headers: {'x-coderabbitai-api-key': '<api-key>'}};
fetch('https://api.coderabbit.ai/v1/verify/repositories/{repository_id}/bugs/{bug_id}/history', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));{
"total": 123,
"next_cursor": "<string>",
"affected_run_count": 123,
"observations": [
{
"observation_id": "<string>",
"bug_id": "<string>",
"execution_id": "<string>",
"cuj_id": "<string>",
"bug": {
"title": "<string>",
"description": "<string>",
"reproductionSteps": [
"<string>"
],
"expectedBehavior": "<string>",
"actualBehavior": "<string>",
"evidenceArtifactIds": [
"<string>"
]
},
"payload_unavailable": true,
"job_id": "<string>",
"source": "<string>",
"run_id": "<string>",
"run_started_at": "<string>",
"pull_request_number": 123,
"repository_registration_id": "<string>",
"branch": "<string>",
"environment_id": "<string>",
"head_sha": "<string>",
"occurred_at": "<string>",
"scenario_title": "<string>"
}
]
}{
"error": {
"code": "invalid_request",
"message": "<string>",
"retry_after": 1
}
}{
"error": {
"code": "unauthenticated",
"message": "<string>",
"retry_after": 1
}
}{
"error": {
"code": "forbidden",
"message": "<string>",
"retry_after": 1
}
}{
"error": {
"code": "not_found",
"message": "<string>",
"retry_after": 1
}
}{
"error": {
"code": "head_changed",
"message": "<string>",
"retry_after": 1
}
}{
"error": {
"code": "precondition_failed",
"message": "<string>",
"retry_after": 1
}
}{
"error": {
"code": "payload_too_large",
"message": "<string>",
"retry_after": 1
}
}{
"error": {
"code": "rate_limit_exceeded",
"message": "<string>",
"retry_after": 1
}
}{
"error": {
"code": "internal_error",
"message": "<string>",
"retry_after": 1
}
}{
"error": {
"code": "unavailable",
"message": "<string>",
"retry_after": 1
}
}- CLI Tool
- MCP Server
coderabbit api request "/verify/repositories/$REPOSITORY_ID/bugs/$BUG_ID/history"
An agent connected to the CodeRabbit MCP server runs this operation as the
get_verify_bug_history tool. The connection selects the organization, so the arguments have no org_id or org_name.{
"method": "tools/call",
"params": {
"name": "get_verify_bug_history",
"arguments": {
"repository_id": "<repository_id>",
"bug_id": "<bug_id>"
}
}
}
Authorizations
See Authentication for the key types and where to create a key.
Query Parameters
Organization for a workspace key: the Git-provider organization ID (scope.provider_organization_id) or the CodeRabbit organization ID (scope.id, or id from list organizations). Supply either org_id or org_name, never both. Omit for organization keys and MCP connections.
Minimum string length:
1Was this page helpful?