Previous Next JavaScript must be enabled to correctly display this content

## 55.3.2 API Consumption - Schedule Reports

This topic describes the systematic instruction to API Consumption - Schedule Report option.

The reports that are generated in specific time frame such as daily, weekly, monthly, quarterly, and annually are categorized under scheduled reports.

To generate the API consumption schedule report:

1. Navigate to the above path.
   The Report Generation screen appears.
2. Click the Schedule tab.
   The Scheduled Report Generation screen appears.
3. From the Report Name list, select the appropriate report to be generated.
   The respective report generation screen appears.

   Figure 55-10 API Consumption Report - Schedule Report

   Description of "Figure 55-10 API Consumption Report - Schedule Report"

   Note:

   The fields which are marked as Required are mandatory.

   For more information on fields, refer to the field description table.

   Table 55-9 API Consumption Report - Schedule Report - Field Description

   Field Name | Description
   --- | ---
   Report Name | Select the type of report to be generated.
   Report Format | Select the format in which the report is to be generated The options with Internal Reporting Application are: PDF CSV
   Select Frequency | Select the frequency at which the report is to be generated. The options are: Once Daily Weekly Monthly
   Start Generating | Date from which the report is to be generated as per frequency defined.
   Stop Generating | Date till which the report is to be generated as per frequency defined.
   Frequency | Select the frequency at which the report is to be generated. The options are: Once Daily Weekly Monthly
   Touch Point | The different channels/ medium for which you want to generate the report.
   Party ID | The party ID for whom the report is to be generated.
   User Segment | The user segment for which the report is to be generated. The options are: Corporate User Retail User Administrator
   User id | The user id of the user for whom report is to be generated.
   View Scheduled Reports | Link to view all the reports that are scheduled.

4. From the Report Format list, select the appropriate report output format.
5. From the Select Frequency list, select the appropriate option.
6. From the Start Generating and Stop Generating list, select the appropriate duration.
7. From the Frequency list, select the appropriate option.
8. From the Touch Point list, select the appropriate option.
9. In the Party ID field, enter the party id.
10. From the User Segment list, select the appropriate segment.
11. In the User Id field, enter the id of the user for whom the report is to be generated.
12. Perform anyone of the following actions:
    - Click Schedule Report to generate and view the report.
    - Click the View Scheduled Reports link to view all the scheduled reports.

      The Scheduled Reports screen appears.

    - Click Cancel to cancel the transaction.
    - Click Clear to reset the search parameters.
13. Perform anyone of the following actions:
    - The success message along with the reference number, status and Report Request Id appears. Click Ok to close the screen and navigate to the dashboard.
    - Click on the View Reports link to download the report.

      The user is directed to the My Reports screen. The list of reports appears.

    - Click Schedule another Report to generate another report.
14. In the My Reports screen, click on desired Report Sub ID to view and download the generated report.
    A report will be generated in the format specified at the time of scheduling or generating an adhoc report.

    Note:

    You can also download the requested report from Administrator Dashboard, click Toggle Menu, then click Reports and then click My Reports, In the My Reports screen, click Scheduled Reports.

Parent topic: API Consumption Report