Skip to content

add reporting guide #187

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 14 commits into from
Jan 3, 2025
Merged
Prev Previous commit
Next Next commit
adding notes and fix position
  • Loading branch information
alexcoderabbitai committed Jan 3, 2025
commit f6d829a144add281173719bb6230a0bdd6cf9b85
2 changes: 1 addition & 1 deletion docs/guides/custom-reports.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@
title: Custom Reports
sidebar_label: Custom Reports
description: Learn how to create custom reports with CodeRabbit Pro's flexible reporting system
sidebar_position: 8
sidebar_position: 7
---

```mdx-code-block
Expand Down
14 changes: 13 additions & 1 deletion docs/guides/ondemand-reports.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@
title: On-demand Reports
sidebar_label: On-demand Reports
description: CodeRabbit offers a way to generate on-demand reports using a simple API request
sidebar_position: 6
sidebar_position: 8
---

```mdx-code-block
Expand All @@ -12,6 +12,18 @@ import ProPlanNotice from '@site/src/components/ProPlanNotice.mdx';
<ProPlanNotice />
```

## Overview

CodeRabbit's reporting feature helps you track and analyze pull request activity across your repositories. There are two ways to generate reports:

1. **[Scheduled Reports](./scheduled-reports.md)** - Set up automated recurring reports that are delivered on a schedule to your preferred channels (email, Slack, MS Teams). This is the recommended way to keep your team informed about development progress.

2. **On-demand Reports** (this guide) - Generate reports programmatically through our API when you need them. This is useful for integration with your own tools and workflows.

If you're new to CodeRabbit's reporting features, we recommend starting with [Scheduled Reports](./scheduled-reports.md) to understand the available options and capabilities.

## API Access

CodeRabbit offers a way to generate on-demand reports using the [CodeRabbit API](https://api.coderabbit.ai/api/swagger/).
You will need an API Key to access the CodeRabbit API and generate an on-demand report.

Expand Down
2 changes: 1 addition & 1 deletion docs/guides/scheduled-reports.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@
title: Scheduled Reports
sidebar_label: Scheduled Reports
description: Learn how to set up automated recurring reports with CodeRabbit Pro
sidebar_position: 7
sidebar_position: 6
---

```mdx-code-block
Expand Down
Loading