Skip to main content
POST
/
v1
/
report.generate
cURL
curl --request POST \
  --url https://api.coderabbit.ai/api/v1/report.generate \
  --header 'Content-Type: application/json' \
  --header 'x-coderabbitai-api-key: <api-key>' \
  --data '
{
  "from": "2024-05-01",
  "to": "2024-05-15"
}
'
[
  {
    "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"
  }
]

Authorizations

​
x-coderabbitai-api-key
string
header
required

API key for authentication. You can create an API key from the CodeRabbit dashboard.

Headers

​
x-coderabbitai-api-key
string
required

Your CodeRabbit API key

Body

application/json
​
from
string<date>
required

Start date for the report in ISO 8601 format (YYYY-MM-DD)

​
to
string<date>
required

End date for the report in ISO 8601 format (YYYY-MM-DD)

​
scheduleRange
enum<string>
Available options:
Dates
​
prompt
string

Custom prompt to specify what information should be included in the report and how it should be formatted

​
promptTemplate
enum<string>

Pre-defined template for the report format

Available options:
Daily Standup Report,
Sprint Report,
Release Notes,
Custom
​
parameters
object[]

Array of filter parameters to narrow down the report scope

​
groupBy
enum<string>

Primary grouping for the report

Available options:
NONE,
REPOSITORY,
LABEL,
TEAM,
USER,
SOURCEBRANCH,
TARGETBRANCH,
STATE
​
subgroupBy
enum<string>

Secondary grouping for the report

Available options:
NONE,
REPOSITORY,
LABEL,
TEAM,
USER,
SOURCEBRANCH,
TARGETBRANCH,
STATE
​
orgId
string

Organization ID (optional)

Response

Successful response

​
group
string
required

The name of the report group

​
report
string
required

The formatted report content as a markdown string