# CodeRabbit

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

App · 18 actions. Web page: https://docs.lodol.com/docs/integrations/coderabbit

## Actions

### Get a published review summary

Get a published review summary for your connected CodeRabbit account.

**Inputs**

- Repository (`repository_id`, text, required): Repository id.
- Pull request number (`pull_request_number`, number, required): Pull request number. From 0 to 2147483647.

**Outputs**: Response.

- `data` (object): Data.

**Example output**

```json
{
  "data": {
    "current_head_sha": "example"
  }
}
```

### Get a repository

Get a repository for your connected CodeRabbit account.

**Inputs**

- Repository (`repository_id`, text, required): Repository id.

**Outputs**: Response.

- `data` (object): Data.

**Example output**

```json
{
  "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.

- `data` (object): Data.

**Example output**

```json
{
  "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.

- `data` (object): Data.

**Example output**

```json
{
  "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.

- `data` (object): Data.

**Example output**

```json
{
  "data": {
    "legacyCli": {
      "reason": "forbidden"
    },
    "prepaid": {
      "reason": "forbidden"
    }
  }
}
```

### Get effective review settings

Get effective review settings for your connected CodeRabbit account.

**Inputs**

- Repository (`repository_id`, text, required): Repository id.

**Outputs**: Response.

- `data` (object): Data.

**Example output**

```json
{
  "data": {
    "layers": [],
    "yaml": "example"
  }
}
```

### Get MCP usage metrics

Get MCP usage metrics for your connected CodeRabbit account.

**Inputs**

- Start date (`start_date`, date, required): Start date.
- End date (`end_date`, date, required): End date.
- Limit (`limit`, number): Limit. From 1 to 1000.
- Cursor (`cursor`, text): Cursor.

**Outputs**: Response.

- `data` (object): Data.

**Example output**

```json
{
  "data": {
    "data": [],
    "next_cursor": "example"
  }
}
```

### Get pull request details

Get pull request details for your connected CodeRabbit account.

**Inputs**

- Repository (`repository_id`, text, required): Repository id.
- Pull request number (`pull_request_number`, number, required): Pull request number. From 0 to 2147483647.

**Outputs**: Response.

- `data` (object): Data.

**Example output**

```json
{
  "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 date (`start_date`, date, required): Start date.
- End date (`end_date`, date, required): End date.
- Status (`status`, text): Status. One of: `merged`, `closed`, `all`.
- Limit (`limit`, number): Limit. From 1 to 1000.
- Cursor (`cursor`, text): Cursor.

**Outputs**: Response.

- `data` (object): Data.

**Example output**

```json
{
  "data": {
    "data": [],
    "next_cursor": "example"
  }
}
```

### Get repository review settings

Get repository review settings for your connected CodeRabbit account.

**Inputs**

- Repository (`repository_id`, text, required): Repository id.

**Outputs**: Response.

- `data` (object): Data.

**Example output**

```json
{
  "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 date (`start_date`, date, required): Start date.
- End date (`end_date`, date, required): End date.
- Limit (`limit`, number): Limit. From 1 to 1000.
- Cursor (`cursor`, text): Cursor.

**Outputs**: Response.

- `data` (object): Data.

**Example output**

```json
{
  "data": {
    "data": [],
    "next_cursor": "example"
  }
}
```

### Get review status

Get review status for your connected CodeRabbit account.

**Inputs**

- Repository (`repository_id`, text, required): Repository id.
- Pull request number (`pull_request_number`, number, required): Pull request number. From 0 to 2147483647.

**Outputs**: Response.

- `data` (object): Data.

**Example output**

```json
{
  "data": {
    "head_sha": "example"
  }
}
```

### List CodeRabbit learnings

List CodeRabbit learnings for your connected CodeRabbit account.

**Inputs**

- Search (`search`, text): Search.
- Limit (`limit`, number): Limit. From 1 to 1000.
- Cursor (`cursor`, text): Cursor.

**Outputs**: Response.

- `data` (object): Data.

**Example output**

```json
{
  "data": {
    "data": [],
    "next_cursor": "example"
  }
}
```

### List linked repositories

List linked repositories for your connected CodeRabbit account.

**Inputs**

- Limit (`limit`, number): Limit. From 1 to 100.
- Cursor (`cursor`, text): Cursor.

**Outputs**: Response.

- `data` (object): Data.

**Example output**

```json
{
  "data": {
    "data": [],
    "next_cursor": "example"
  }
}
```

### List organizations

List organizations for your connected CodeRabbit account.

**Inputs**

- Limit (`limit`, number): Limit. From 1 to 100.
- Cursor (`cursor`, text): Cursor.

**Outputs**: Response.

- `data` (object): Data.

**Example output**

```json
{
  "data": {
    "next_cursor": "example",
    "organizations": []
  }
}
```

### List pull requests

List pull requests for your connected CodeRabbit account.

**Inputs**

- Repository (`repository_id`, text, required): Repository id.
- Author (`author`, text): Author.
- State (`state`, text): State. One of: `open`, `closed`, `merged`, `all`.
- Head branch (`head_branch`, text): Head branch.
- Limit (`limit`, number): Limit. From 1 to 100.
- Cursor (`cursor`, text): Cursor.

**Outputs**: Response.

- `data` (object): Data.

**Example output**

```json
{
  "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 name (`full_name`, text): Full name.
- Limit (`limit`, number): Limit. From 1 to 100.
- Cursor (`cursor`, text): Cursor.

**Outputs**: Response.

- `data` (object): Data.

**Example output**

```json
{
  "data": {
    "data": [],
    "next_cursor": "example"
  }
}
```

### List repositories for an organization

List repositories for an organization for your connected CodeRabbit account.

**Inputs**

- Organization (`organization_id`, text, required): Organization id.
- Limit (`limit`, number): Limit. From 1 to 100.
- Cursor (`cursor`, text): Cursor.

**Outputs**: Response.

- `data` (object): Data.

**Example output**

```json
{
  "data": {
    "next_cursor": "example",
    "repositories": []
  }
}
```
