š CodeRabbit Agent for Slack - From idea to pull request without leaving Slack. Get started!
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"
}
]DEPRECATED: Generate a developer activity report based on the provided parameters and date range. This endpoint may take up to 10 minutes to respond depending on the data volume. Prompts cannot be used and this is only for testing purposes. We recommend creating a recurring report and triggering a preview via the UI instead.
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"
}
]Documentation Index
Fetch the complete documentation index at: https://docs.coderabbit.ai/llms.txt
Use this file to discover all available pages before exploring further.
API key for authentication. You can create an API key from the CodeRabbit dashboard.
Your CodeRabbit API key
Start date for the report in ISO 8601 format (YYYY-MM-DD)
End date for the report in ISO 8601 format (YYYY-MM-DD)
Dates Custom prompt to specify what information should be included in the report and how it should be formatted
Pre-defined template for the report format
Daily Standup Report, Sprint Report, Release Notes, Custom Array of filter parameters to narrow down the report scope
Show child attributes
Primary grouping for the report
NONE, REPOSITORY, LABEL, TEAM, USER, SOURCEBRANCH, TARGETBRANCH, STATE Secondary grouping for the report
NONE, REPOSITORY, LABEL, TEAM, USER, SOURCEBRANCH, TARGETBRANCH, STATE Organization ID (optional)
Was this page helpful?