CodeRabbit

App · 18 actions

Read CodeRabbit reviews, repository settings, pull requests and usage.

Actions

ActionWhat it does
Get a published review summaryGet a published review summary for your connected CodeRabbit account.
Get a repositoryGet a repository for your connected CodeRabbit account.
Get account usageGet account usage for your connected CodeRabbit account.
Get connected identityGet connected identity for your connected CodeRabbit account.
Get credit balancesGet credit balances for your connected CodeRabbit account.
Get effective review settingsGet effective review settings for your connected CodeRabbit account.
Get MCP usage metricsGet MCP usage metrics for your connected CodeRabbit account.
Get pull request detailsGet pull request details for your connected CodeRabbit account.
Get pull request review metricsGet pull request review metrics for your connected CodeRabbit account.
Get repository review settingsGet repository review settings for your connected CodeRabbit account.
Get review comment metricsGet review comment metrics for your connected CodeRabbit account.
Get review statusGet review status for your connected CodeRabbit account.
List CodeRabbit learningsList CodeRabbit learnings for your connected CodeRabbit account.
List linked repositoriesList linked repositories for your connected CodeRabbit account.
List organizationsList organizations for your connected CodeRabbit account.
List pull requestsList pull requests for your connected CodeRabbit account.
List repositoriesList repositories for your connected CodeRabbit account.
List repositories for an organizationList repositories for an organization for your connected CodeRabbit account.

Get a published review summary

Get a published review summary for your connected CodeRabbit account.

Inputs

Repositoryrepository_idtextRequired
Repository id.
Pull request numberpull_request_numbernumberRequired
Pull request number.From 0 to 2147483647.

Outputs

Response.

dataobject
Data.
Example output
{
  "data": {
    "current_head_sha": "example"
  }
}

Get a repository

Get a repository for your connected CodeRabbit account.

Inputs

Repositoryrepository_idtextRequired
Repository id.

Outputs

Response.

dataobject
Data.
Example output
{
  "data": {
    "full_name": "example",
    "html_url": "example",
    "id": "example",
    "name": "example"
  }
}

Get account usage

Get account usage for your connected CodeRabbit account.

Inputs

None.

Outputs

Response.

dataobject
Data.
Example output
{
  "data": {
    "billingPeriod": {
      "reason": "forbidden"
    },
    "credits": {
      "legacyCli": {
        "reason": "forbidden"
      },
      "prepaid": {
        "reason": "forbidden"
      }
    },
    "includedReviews": {
      "reason": "forbidden"
    },
    "organization": {
      "id": "example",
      "name": "example"
    }
  }
}

Get connected identity

Get connected identity for your connected CodeRabbit account.

Inputs

None.

Outputs

Response.

dataobject
Data.
Example output
{
  "data": {
    "principal": {
      "id": "example",
      "key_type": "user",
      "owner": {
        "provider_user_id": "example",
        "role": "example"
      }
    },
    "scope": {
      "id": "example",
      "name": "example",
      "provider": "example",
      "provider_organization_id": "example",
      "workspace_id": "example"
    }
  }
}

Get credit balances

Get credit balances for your connected CodeRabbit account.

Inputs

None.

Outputs

Response.

dataobject
Data.
Example output
{
  "data": {
    "legacyCli": {
      "reason": "forbidden"
    },
    "prepaid": {
      "reason": "forbidden"
    }
  }
}

Get effective review settings

Get effective review settings for your connected CodeRabbit account.

Inputs

Repositoryrepository_idtextRequired
Repository id.

Outputs

Response.

dataobject
Data.
Example output
{
  "data": {
    "layers": [],
    "yaml": "example"
  }
}

Get MCP usage metrics

Get MCP usage metrics for your connected CodeRabbit account.

Inputs

Start datestart_datedateRequired
Start date.
End dateend_datedateRequired
End date.
Limitlimitnumber
Limit.From 1 to 1000.
Cursorcursortext
Cursor.

Outputs

Response.

dataobject
Data.
Example output
{
  "data": {
    "data": [],
    "next_cursor": "example"
  }
}

Get pull request details

Get pull request details for your connected CodeRabbit account.

Inputs

Repositoryrepository_idtextRequired
Repository id.
Pull request numberpull_request_numbernumberRequired
Pull request number.From 0 to 2147483647.

Outputs

Response.

dataobject
Data.
Example output
{
  "data": {
    "blockers": [],
    "checks": {
      "complete": false,
      "items": [],
      "requiredness_known": false
    },
    "coverage": {
      "complete": false,
      "limitations": []
    },
    "expected_head_sha": "example",
    "fetched_at": "example",
    "head_changed": false,
    "head_sha": "example",
    "merge": {
      "applicable": false,
      "mergeable": "mergeable",
      "provider_state": "example",
      "queue_entry": "example",
      "queue_known": false,
      "requirements_known": false
    },
    "pull_request": {
      "base_branch": "example",
      "base_sha": "example",
      "description": "example",
      "draft": false,
      "head_branch": "example",
      "head_owner": "example",
      "head_sha": "example",
      "id": "example",
      "number": 1,
      "repository": "example",
      "state": "open",
      "title": "example",
      "updated_at": "example",
      "url": "example"
    },
    "reviews": {
      "coderabbit": {
        "reviewed_sha": "example",
        "source_url": "example",
        "status": "in_progress_observed"
      },
      "complete": false,
      "decision": "example",
      "items": []
    },
    "threads": {
      "applied_filters": {
        "author": "example",
        "include_outdated": false,
        "include_replies": false,
        "limit": 1,
        "state": "unresolved"
      },
      "coverage": {
        "complete": false,
        "limitations": []
      },
      "data": [],
      "fetched_at": "example",
      "head_changed": false,
      "head_sha": "example",
      "next_cursor": "example",
      "returned": 1
    }
  }
}

Get pull request review metrics

Get pull request review metrics for your connected CodeRabbit account.

Inputs

Start datestart_datedateRequired
Start date.
End dateend_datedateRequired
End date.
Statusstatustext
Status.One of: merged, closed, all.
Limitlimitnumber
Limit.From 1 to 1000.
Cursorcursortext
Cursor.

Outputs

Response.

dataobject
Data.
Example output
{
  "data": {
    "data": [],
    "next_cursor": "example"
  }
}

Get repository review settings

Get repository review settings for your connected CodeRabbit account.

Inputs

Repositoryrepository_idtextRequired
Repository id.

Outputs

Response.

dataobject
Data.
Example output
{
  "data": {
    "enabled": false,
    "inherited": false,
    "repository_id": "example",
    "settings": {
      "chat": {
        "allow_non_org_members": false,
        "art": false,
        "auto_reply": false,
        "integrations": {
          "jira": {},
          "linear": {}
        }
      },
      "code_generation": {
        "docstrings": {
          "language": "de",
          "path_instructions": []
        },
        "unit_tests": {
          "path_instructions": []
        }
      },
      "early_access": false,
      "enable_free_tier": false,
      "inheritance": false,
      "issue_enrichment": {
        "auto_enrich": {
          "enabled": false
        },
        "labeling": {
          "auto_apply_labels": false,
          "labeling_instructions": []
        },
        "planning": {
          "auto_planning": {},
          "enabled": false
        }
      },
      "knowledge_base": {
        "automatic_linking_mode": "auto",
        "automatic_repository_linking": false,
        "code_guidelines": {
          "enabled": false,
          "filePatterns": []
        },
        "issues": {
          "scope": "local"
        },
        "jira": {
          "excluded_project_keys": [],
          "project_keys": [],
          "usage": "auto"
        },
        "learnings": {
          "approval_delay": 1,
          "scope": "local"
        },
        "linear": {
          "team_keys": [],
          "usage": "auto"
        },
        "linked_repositories": [],
        "mcp": {
          "usage": "auto"
        },
        "opt_out": false,
        "pull_requests": {
          "scope": "local"
        },
        "web_search": {
          "enabled": false
        }
      },
      "language": "de",
      "tone_instructions": "example"
    },
    "settings_updated_at": "example",
    "settings_yaml": "example"
  }
}

Get review comment metrics

Get review comment metrics for your connected CodeRabbit account.

Inputs

Start datestart_datedateRequired
Start date.
End dateend_datedateRequired
End date.
Limitlimitnumber
Limit.From 1 to 1000.
Cursorcursortext
Cursor.

Outputs

Response.

dataobject
Data.
Example output
{
  "data": {
    "data": [],
    "next_cursor": "example"
  }
}

Get review status

Get review status for your connected CodeRabbit account.

Inputs

Repositoryrepository_idtextRequired
Repository id.
Pull request numberpull_request_numbernumberRequired
Pull request number.From 0 to 2147483647.

Outputs

Response.

dataobject
Data.
Example output
{
  "data": {
    "head_sha": "example"
  }
}

List CodeRabbit learnings

List CodeRabbit learnings for your connected CodeRabbit account.

Inputs

Searchsearchtext
Search.
Limitlimitnumber
Limit.From 1 to 1000.
Cursorcursortext
Cursor.

Outputs

Response.

dataobject
Data.
Example output
{
  "data": {
    "data": [],
    "next_cursor": "example"
  }
}

List linked repositories

List linked repositories for your connected CodeRabbit account.

Inputs

Limitlimitnumber
Limit.From 1 to 100.
Cursorcursortext
Cursor.

Outputs

Response.

dataobject
Data.
Example output
{
  "data": {
    "data": [],
    "next_cursor": "example"
  }
}

List organizations

List organizations for your connected CodeRabbit account.

Inputs

Limitlimitnumber
Limit.From 1 to 100.
Cursorcursortext
Cursor.

Outputs

Response.

dataobject
Data.
Example output
{
  "data": {
    "next_cursor": "example",
    "organizations": []
  }
}

List pull requests

List pull requests for your connected CodeRabbit account.

Inputs

Repositoryrepository_idtextRequired
Repository id.
Authorauthortext
Author.
Statestatetext
State.One of: open, closed, merged, all.
Head branchhead_branchtext
Head branch.
Limitlimitnumber
Limit.From 1 to 100.
Cursorcursortext
Cursor.

Outputs

Response.

dataobject
Data.
Example output
{
  "data": {
    "applied_filters": {
      "author": "example",
      "head_branch": "example",
      "head_owner": "example",
      "limit": 1,
      "repository_id": "example",
      "state": "open"
    },
    "coverage": {
      "complete": false,
      "limitations": []
    },
    "data": [],
    "fetched_at": "example",
    "next_cursor": "example"
  }
}

List repositories

List repositories for your connected CodeRabbit account.

Inputs

Full namefull_nametext
Full name.
Limitlimitnumber
Limit.From 1 to 100.
Cursorcursortext
Cursor.

Outputs

Response.

dataobject
Data.
Example output
{
  "data": {
    "data": [],
    "next_cursor": "example"
  }
}

List repositories for an organization

List repositories for an organization for your connected CodeRabbit account.

Inputs

Organizationorganization_idtextRequired
Organization id.
Limitlimitnumber
Limit.From 1 to 100.
Cursorcursortext
Cursor.

Outputs

Response.

dataobject
Data.
Example output
{
  "data": {
    "next_cursor": "example",
    "repositories": []
  }
}

On this page