Home > User Guide > Reporting > View API Usage Report

    Export to PDF

    View API Usage Report

    Navigate to Reporting > API usage to view the API usage report of organizations under the corresponding tabs.

    The API Usage chart displays the percentage of the API usage limit by including both running and completed jobs in AvePoint Cloud Backup for Salesforce® as well as the API usage limit percentage of the organization in the last 7 days. To maintain optimum performance and ensure that the Force.com API is available to all Salesforce customers, Salesforce balances transaction loads by imposing Total API Request Limits per 24 hours. When a call exceeds a request limit, an error is returned. The chart can provide you with a convenient way to check the condition of API usage. If a call exceeds the request limit, the backup, archive or restore job will pause. AvePoint Cloud Backup for Salesforce® will keep the progress and enquire Salesforce every 30 minutes. When there is an abundant API quota, AvePoint Cloud Backup for Salesforce® will resume the progress to finish the job.

    Administrators can also configure a percentage for the Salesforce API usage limit by clicking Configure API usage limit in the upper-right corner. In the panel, enter an integer from 1 to 100 to define the percentage. Make sure you set an appropriate value to ensure your jobs will not be affected. Click Save to save the configurations, or click Cancel to close the panel without saving the configurations.

    The total number of API requests allowed by Salesforce is defined by the users’ licenses in the organization. For details, refer to the Salesforce documentation: For your current API usage, navigate to Salesforce > System Overview > API Usage.

    Salesforce > System Overview > API Usage.

    If you have enabled Bulk API and Bulk API 2.0 for organizations, you can also view the percentage of Bulk API and Bulk API 2.0 usage limit on this page. To configure the limit, click Configure Bulk API usage in the chart. For details on the settings, refer to Configure Bulk API Usage.