sidebar_position:13

We're excited to announce significant improvements to our reporting system that will make your automated reports more powerful and actionable!

Reports now support exclusion filters using the`NOT_IN` option, allowing you to filter out pull requests based on their repository, label, user, or team. This gives you more granular control over what appears in your reports, helping you focus on the most relevant information.

We've enhanced the default daily standup report template to include a "Next Steps" section. This provides clear guidance on what actions authors and reviewers should take regarding each pull request or change, making your reports more actionable and helping teams stay on track.

Reports now include CI/CD GitHub Action check status as a data source. Your reports will be aware of which CI/CD checks are failing or passing, giving you better visibility into the health of your pull requests and helping identify potential issues before they become blockers.

We've added a new optional score card report feature that allows you to grade and create report cards for your developers. This custom report optional data source provides a structured way to evaluate developer performance and contributions. See our[custom reports documentation](/guides/custom-reports#remove-prs-without-a-score-cardchart-bot-comment) for more details on how to implement score cards in your reports.

-`<comment_updated_at>`: datetime - The date and time the comment was last updated.

-`<comment_body>`: markdown - The content of the comment.

-`<pr_checks>`: array of check objects - Contains all CI/CD checks for the PR._GitHub Only_.

-`<pr_check>`: object - Each individual check is wrapped in this tag and is an object with the following properties:

-`<pr_check_name>`: string - The name of the CI/CD check.

-`<pr_check_status>`: string - The status of the check (e.g., "success", "failure", "in_progress", "canceled").

-`<pr_check_url>`: string - The URL to view the detailed results of the check.

Here's an example prompt that uses these data points:

This option gives you the ability to create a report limited only to pull requests containing a "Score Card" or "Score Chart" bot comment from CodeRabbit or other bots. To enable issues and tickets you must include the tag`<pr_score_card>` in your prompt.

For example you can ask coderabbit to check serveral conditions on a pull request and produce a "Score Chart":

- `1` → Passed

**Final Score Calculation:**

Combine the scores from the parameters above to derive the final code quality score (out of5).

Combine the scores from the parameters above to derive the final code quality score (out of9).

**Output Format:**

Provide the final report in a table format with the following columns (use shorthand notations), be sure to include this list at the top above the chart in the "Column Notation" section so users understand what the columns mean:

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](/guides/reports-overview).

If you're new to CodeRabbit's reporting features, then we recommend starting with[Scheduled reports](/guides/scheduled-reports) to understand the available options and capabilities.

If you're new to CodeRabbit's reporting features, then we recommend starting with[Scheduled reports](/guides/scheduled-reports) to understand the available options and capabilities. In almost every scenario we recommend using the**Scheduled Reports** option. The**On-demand Report** does not have any additional benifits from the**Scheduled Reports** and has many limitations.

There are two ways to generate reports:

-**[Scheduled Reports](/guides/scheduled-reports)**: Set up automated, recurring reports that are delivered to your team on a set schedule. Supported delivery channels include the following:

-**[Scheduled Reports](/guides/scheduled-reports)**: Set up automated, recurring reports that are delivered to your team on a set schedule.**Use this option if you want to adjust your settings and send a report more than once**.Supported delivery channels include the following:

- Email

- Discord

- Slack

- Teams

-**[On-demand Reports](/guides/ondemand-reports)**: If yourequire customized integration of reports with your own tools and workflows, then youcan generate reports programmatically through our API.

-**[On-demand Reports](/guides/ondemand-reports)**: If youwant to test a report format and produce a single report once, try the "On-demand Reports" Option. Youcanalsogenerate reports programmatically through our API, but we do not recommend this as the API reporting is in beta. If you want to run an**On-demand Report** more than once then you must use the**Scheduled Reports** option.

For your first reports, we recommendexploring scheduled reports. Its web-based UI can help you get familiar withtheoptions available to you.

In almost every scenario we recommendusing the**Scheduled Reports** option. The**On-demand Report** does not have any additional benifits fromthe**Scheduled Reports** and has many limitations.

Reports can be filtered using multiple parameters:

Reports can be filtered using multiple parameters, match pull requests using the**IN** option and exclude pull requests using the**NOT_IN** option:

-**Repositories**: Select specific repositories to monitor

-**Labels**: Filter by GitHub labels with operators:

- IN: Match any selected label

- NOT_IN: Exclude any pr with select label

- ALL: Match all selected labels

-**Users**: Filter by specific GitHub users

-**Teams**: Filter by organization teams

[Shopify CLI](https://github.com/Shopify/cli) is a command-line tool that helps you build Shopify apps, themes, and custom storefronts. It provides functionality for initializing, building, developing, and deploying Shopify projects.

The tool only runs when the following conditions are met:

- Only processes pull requests changing`*.liquid` files

- Requires either`.theme-check.yml` or`.theme-check.yaml` configuration file in the project root

- Requires the standard Shopify theme directory structure at the project root:

If any of these requirements are not met, the tool will not run.

The tool checks for:

"additionalProperties":false,

"default": {}

},

"pre_merge_checks": {

"type":"object",

"properties": {

"docstrings": {

"type":"object",

"properties": {

"mode": {

"type":"string",

"enum": ["off","warning","error"],

"default":"warning",

"description":"Mode | Level of enforcement for docstring coverage check. Warning only generates a warning and does not require the user to resolve the check. While error requires the user to resolve issues before merging pull request."

},

"threshold": {

"type":"number",

"minimum":0,

"maximum":100,

"default":80,

"description":"Percentage threshold for docstring coverage check."

}

},

"additionalProperties":false,

"default": {},

"description":"Docstring Coverage | Checks if the code has sufficient docstrings."

},

"title": {

"type":"object",

"properties": {

"mode": {

"type":"string",

"enum": ["off","warning","error"],

"default":"warning",

"description":"Mode | Level of enforcement for pull request title check. Warning only generates a warning and does not require the user to resolve the check. While error requires the user to resolve issues before merging pull request."

},

"requirements": {

"type":"string",

"default":"",

"description":"Requirements | Requirements for the pull request title. Example: 'Title should be concise and descriptive, ideally under 50 characters.'"

}

},

"additionalProperties":false,

"default": {},

"description":"Title Check | Checks if the pull request title is appropriate and follows best practices."

},

"description": {

"type":"object",

"properties": {

"mode": {

"type":"string",

"enum": ["off","warning","error"],

"default":"warning",

"description":"Mode | Level of enforcement for pull request description check. Warning only generates a warning and does not require the user to resolve the check. While error requires the user to resolve issues before merging pull request."

}

},

"additionalProperties":false,

"default": {},

"description":"Description Check | Checks if the pull request description is appropriate and follows best practices."

},

"issue_assessment": {

"type":"object",

"properties": {

"mode": {

"type":"string",

"enum": ["off","warning","error"],

"default":"warning",

"description":"Mode | Level of enforcement for linked issue assessment. Warning only generates a warning and does not require the user to resolve the check. While error requires the user to resolve issues before merging pull request."

}

},

"additionalProperties":false,

"default": {},

"description":"Linked Issue Assessment | Checks if the pull request addresses the linked issues. Generate an assessment of how well the changes address the linked issues."

}

},

"additionalProperties":false,

"default": {}

},

"tools": {

"type":"object",

"properties": {

"additionalProperties":false,

"description":"Tools that provide additional context to code reviews.",

"default": {}

},

"pre_merge_checks": {

"type":"object",

"additionalProperties": {},

"default": {}

}

},

"additionalProperties":false,