Previous Next JavaScript must be enabled to correctly display this content

## 55.3.1 API Consumption - Adhoc Report

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

API Consumption Adhoc report is generated on demand or on request. Report can be requested from the Report Generation screen. Adhoc reports can be viewed using My Reports screen.

To generate the API Consumption adhoc report:

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

   Figure 55-8 API Consumption - Adhoc Report

   Description of "Figure 55-8 API Consumption - Adhoc Report"

   Note:

   The fields which are marked as Required are mandatory.

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

   Table 55-7 API Consumption - Adhoc 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
   Duration | The period for which the report is to be generated. Start date of the date range from which you want to generate the report. End date of the date range up-to which you want to generate the report.
   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 segment of user for whom the report is to be generated. The options are: Corporate User Retail User Administrator
   User id | The user id of the user for whom the report is to be generated.

4. From the Report Format list, select the appropriate report output format.
5. From the Duration - From Date and Duration - To Date list, select the appropriate duration.
6. From the Frequency list, select the appropriate option.
7. From the Touch Point list, select the appropriate option.
8. In the Party ID field, enter the party id.
9. From the User Segment list, select the appropriate type of user.
10. In the User Id field, enter the id of the user for whom the report is to be generated.
11. Perform anyone of the following actions:
    - Click Generate Report to generate the report.
    - Click Cancel to cancel the transaction.
    - Click Clear to reset the search parameters.
12. 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 Generate another report to generate another report.
13. 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.

    Figure 55-9 For reference, a specimen of the report generated is given below:

    Description of "Figure 55-9 For reference, a specimen of the report generated is given below:"

    Note:

    The fields which are marked as Required are mandatory.

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

    Table 55-8 API Consumption Details Reports - Field Description

    Field Name | Description
    --- | ---
    Report Parameters | Information specified in below fields are related to report parameters.
    From Date | Date from which the report is generated.
    To Date | Date till which the report is generated.
    Frequency | The frequency at which the report is generated.
    Access Point (Touch Point) | The different channels/ medium for which report is generated.
    Party ID | The party ID for whom the report is generated.
    Party Name | The name of the party for whom the report is generated.
    User Segment | The user segment for which, the report is generated.
    User ID | ID of the user.
    API Name | The name of the API for which the report is generated.
    From Date | Date from which the report is generated.
    To Date | Date till which the report is generated.
    Count | The total count of transactions that are successful and failed.
    Touch Point | The different channels/ medium for which report is generated.
    Status | The status of the transaction.

Parent topic: API Consumption Report