ondemand-reports.md

title	description
Generate reports on demand	CodeRabbit offers a way to generate on-demand reports using a simple API request

import ReportSchema from "@site/src/components/ReportSchema";
import ProPlanNotice from '@site/src/components/ProPlanNotice.mdx';

<ProPlanNotice />

Overview

This page is about using the CodeRabbit API to generate on-demand reports about your organization's usage of CodeRabbit. For a conceptual overview of reports in CodeRabbit, see Generate reports.

If you're new to CodeRabbit's reporting features, theh we recommend starting with Scheduled reports to understand the available options and capabilities.

API Access

CodeRabbit offers a way to generate on-demand reports using the CodeRabbit API. You will need an API Key to access the CodeRabbit API and generate an on-demand report.

Create an API key

Sign in to your CodeRabbit account and navigate to the API Keys page under 'Organization Settings' in the left sidebar. Click on the Create API Key button and enter a name for the API Key. Copy the API key, and keep it safe as it won't be visible again.

Generate an On-demand report

Once you have the API key, pass it in the x-coderabbitai-api-key header when calling the API:

curl -X 'POST' \
  'https://api.coderabbit.ai/api/v1/report.generate' \
  -H 'accept: application/json' \
  -H 'x-coderabbitai-api-key: cr-xxxxxxxxxxxxx' \
  -H 'Content-Type: application/json' \
  -d '{
    "from": "2024-05-01",
    "to": "2024-05-15"
  }'

Sample output:

[
  {
    "group": "Developer Activity",
    "report": "*Developer Activity*:\n\n 🟢 **Update README.md** [#10](https://gitlab.com/master-group123/sub-group/project1/-/merge_requests/10)\n• Summary: The change updates the project description and modifies a section header for clearer instructions.\n• Last activity: 1 day ago, mergeable\n• Insights:\n - :magnifying_glass: @user2 Suggested updating the wording to make it clearer"
  }
]

:::info

If you get a 401 UNAUTHORIZED error, check if you're passing the right API key in the x-coderabbitai-api-key header

:::

The on-demand report generation endpoints take in inputs as per the schema shown below:

<ReportSchema />

API Reference

What's next

• Customize reports
• Scheduled reports