---
title: "POST /api/v1/report.generate"
method: POST
path: "/api/v1/report.generate"
---

# POST /api/v1/report.generate

`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.

## Headers

- `x-coderabbitai-api-key` string, required

## Request body

- object
  - `scheduleRange` 'Dates'
  - `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)
  - `prompt` string — 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
  - `parameters` object[] — Array of filter parameters to narrow down the report scope
    - `parameter` 'REPOSITORY' | 'LABEL' | 'TEAM' | 'USER' | 'SOURCEBRANCH' | 'TARGETBRANCH' | 'STATE', required — Filter type
    - `operator` 'IN' | 'ALL' | 'NOT_IN', required — Filter operator
    - `values` string[], required — Array of string values to filter by
  - `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
  - `orgId` string — Organization ID (optional)

## Response `200`

Successful response

- object[]
  - `group` string, required — The name of the report group
  - `report` string, required — The formatted report content as a markdown string

## Other responses

- `400` — Bad Request
- `401` — Unauthorized
- `403` — Forbidden
- `429` — Too Many Requests

---

[API](https://skmtc.net/coderabbit/apis/coderabbit-api-spec.md) · [All operations](https://skmtc.net/coderabbit/apis/coderabbit-api-spec/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/coderabbit/coderabbit-api-spec/versions/401789d85d01/schema)