You signed in with another tab or window.Reload to refresh your session.You signed out in another tab or window.Reload to refresh your session.You switched accounts on another tab or window.Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: docs/guides/ondemand-reports.md
+1-1Lines changed: 1 addition & 1 deletion
Original file line number
Diff line number
Diff line change
@@ -14,7 +14,7 @@ import ProPlanNotice from '@site/src/components/ProPlanNotice.mdx';
14
14
15
15
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).
16
16
17
-
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.
17
+
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.
Copy file name to clipboardExpand all lines: docs/guides/reports-overview.md
+3-3Lines changed: 3 additions & 3 deletions
Original file line number
Diff line number
Diff line change
@@ -17,16 +17,16 @@ You can track and analyze pull request activity across your organization's repos
17
17
18
18
There are two ways to generate reports:
19
19
20
-
-**[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:
20
+
-**[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:
21
21
22
22
- Email
23
23
- Discord
24
24
- Slack
25
25
- Teams
26
26
27
-
-**[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.
27
+
-**[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.
28
28
29
-
For your first reports, we recommendexploring scheduled reports. Its web-based UI can help you get familiar withtheoptions available to you.
29
+
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.
30
30
31
31
##Customize reports using natural language {#customize}