COcoderabbit

POST /api/v1/report.generate

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.

Request

  • Base URL
    https://api.coderabbit.ai
  • Auth
    API key in header x-coderabbitai-api-key

Headers

x-coderabbitai-api-keystring required

Your CodeRabbit API key

Request body

scheduleRange'Dates'
fromstring date required

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

tostring date required

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

promptstring

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

promptTemplate'Daily Standup Report' | 'Sprint Report' | 'Release Notes' | 'Custom'

Pre-defined template for the report format

groupBy'NONE' | 'REPOSITORY' | 'LABEL' | 'TEAM' | 'USER' | 'SOURCEBRANCH' | 'TARGETBRANCH' | 'STATE'

Primary grouping for the report

subgroupBy'NONE' | 'REPOSITORY' | 'LABEL' | 'TEAM' | 'USER' | 'SOURCEBRANCH' | 'TARGETBRANCH' | 'STATE'

Secondary grouping for the report

orgIdstring

Organization ID (optional)

Response

Successful response

groupstring required

The name of the report group

reportstring required

The formatted report content as a markdown string

Changes

No recorded changes to this operation across all 14 revisions of this API.