API Usage Center overview

The API Usage Center is a dashboard that enables you to monitor the efficiency of apps that your account uses to make API calls. You can:

• Monitor the number of API calls over a period of time
• Determine which apps approached or exceeded API resource limits
• See efficiency scores for your apps
• Learn how to address issues that reduce app efficiency
• Update the hourly call limit

Monitoring performance through the API Usage Center enables you to:

• Provide optimized, scalable integrations for your organization or clients
• Take action if your apps require an API limit increase

The API Usage Center currently reflects activity from these APIs:

• eSignature REST API
• eSignature SOAP API

Accessing the API Usage Center

The API Usage Center is available in both the developer (demo) and production environments:

• API Usage Center: Developer environment
• API Usage Center: Production environment

You can also view the API Usage Center by following these steps:

1. Log in to your developer or production account.
2. Select Admin from the top menu.
3. Under Integrations in the left menu, select API Usage Center.

API Usage Center main dashboard

The main dashboard consists of these components, which are described in detail in the sections below:

• API Calls
• API Calls by App (Integration Key)
• API Limit
• API Activity by App

Filters help you to control the view of several of these components.

Filters

Two filters at the top of the page tailor the display of data in the page’s graph and table components:

• Integration key filter
• Date range dropdown

Filtering by integration key

When you filter by integration key, the data will include only those API calls made by the selected integration key(s).

To filter by integration key:

1. In the filter at the top of the page, click or tap Add Filter.
2. Select Integration Key.
3. Enter one or more integration keys with a space between each.
4. Select Add Filter.

Changing the date range

When you filter by date range, the data will include API calls from that time frame only.

To change the date range, select one of these options in the dropdown at the top of the page:

• Last 24 hours
• Last 2 days
• Last 7 days
• Last 10 days
• Last 30 days

All date ranges end at the beginning of the current hour. The time zone used here is the one configured in your Regional Settings. For example, if you select Last 24 hours and the time is currently 3:20 pm in the time zone selected in your Regional Settings, the data will be updated to reflect activity during the 24 hours ending at 3:00 pm. Selecting Last 30 days causes the charts to reflect API activity for the 30 days ending at 3:00 pm.

Bookmarking filters

If you use specific filter values often, you can save them by setting them in the API Usage Center and then bookmarking the page. The URI will record your filter settings and, when you load your bookmark, the filters will also be loaded.

API Calls

The API Calls component displays your apps’ API calls per hour over a length of time.

Times shown on the horizontal axis are start times. For example, the total for 11:00 pm on December 14 represents calls made from 11:00 pm on December 14 through 12:00 am on December 15. The length of time displayed on the graph and the apps included in the totals are configurable using the filters.

Customizing the API Calls display

You can customize the data in this component in two ways:

• In the upper-left corner, the View dropdown enables you to choose whether the totals include all API calls, or only those that succeeded or failed.
• In the upper-right corner, an actions menu enables you to show or hide the API call limit. SelectingShow rate limit displays a red horizontal line representing the limit. This indicates how close your apps are to the limit. Exceeding it can cause Docusign to block your apps’ calls.

Accessing additional data from the API Calls component

The API Calls component enables you to access more granular data in several ways:

• Hover the cursor over a point on the graph to display a window showing the date, time, and number of API calls during that one-hour interval. The time shown in the window is the start time in the time zone configured in your Regional Settings.
• Select any point on the graph to launch a window that contains a breakdown in doughnut chart format of the calls during that one-hour interval for each app. Hover the cursor over a segment of the doughnut chart to see the number of calls for a particular app during that hour. The time shown in the window is the start time of the interval during which the displayed number of calls occurred, in the time zone configured in your Regional Settings. Note: If App name not known is displayed instead of the app name, the corresponding integration key is not associated with your account, so the app name cannot be retrieved. Select View Details to see a list of the last 500 API calls made during the one-hour interval in descending order by timestamp. The View button in the right-hand column of each row launches a window that lists details about that call. The Download Logs button in the upper right corner of the page downloads the details of all the calls listed on the page in a CSV file.

API Calls by App (Integration Key)

The API Calls by App (Integration Key) component summarizes total API calls by app. Your selections in the filters determine the time frame and apps included.

Hover the cursor over a segment of the doughnut chart to see the number of calls and the efficiency score for a particular app during the selected time frame.

Note: If App name not known is displayed instead of the app name, the corresponding integration key is not associated with your account, so the app name cannot be retrieved.

API Activity by App

The API Activity by App component lists call volume and performance metrics. Your selections in the filters determine the time frame and apps included.

The following table describes the information provided for each app:

API Efficiency

The API Efficiency page contains two components that assess your app’s efficiency and offer recommendations for how to improve it, if possible:

• Efficiency Score: an overall score that indicates how efficient the app is, and provides a rating.
• Negative Efficiency Factors: a detailed analysis of any issues reducing your app’s efficiency.

You can access the API Efficiency page for one of your apps by completing these steps:

1. Open the API Usage Center.
2. Scroll down to the API Activity by App component.
3. Select the Actions button for the app whose score you’d like to view, then select View Efficiency Score in the button’s sub-menu.

Efficiency Score

Each app is assigned an efficiency score based on a number of metrics.

The Efficiency Score component provides the following information:

• Score: The app’s efficiency score. This is a number between zero and 100, with a higher score indicating greater efficiency. The efficiency score is recalculated every day based on API activity over the past seven days, ending at midnight UTC. The score on the API Efficiency page always reflects this time frame, regardless of the date range selected in the filter on the API Usage Center main dashboard. If the app did not make enough API calls during the last seven days for Docusign to analyze its efficiency, the score will be zero.

• Rating: A descriptive term indicating the level of efficiency.

  • Good: Your app is relatively efficient but may benefit from minor improvements. See the factor list for areas to focus on. If the list is empty, no changes are needed.
  • Fair: Your app has minor issues and addressing them can improve performance.
  • Poor: Your app is running at very low efficiency and should be optimized.

• Change in score: The difference between the latest efficiency score and the score calculated 24 hours earlier. A positive number indicates an efficiency increase; a negative number indicates a decrease.

Note: If you make app changes, the full impact may not be reflected immediately in the efficiency score because it is based on the last seven days of activity. General guidelines for efficiency score updates are below:

• For issues occurring daily, you will start to see an improvement in score 48 hours after deploying a successful fix. The full efficiency gain resulting from the fix won’t be reflected in the score for eight days.
• For intermittent issues, you might have to wait up to eight days to see an improvement.

Negative Efficiency Factors

The Negative Efficiency Factors component lists the efficiency problems that are reducing your app’s score. They are listed in order from greatest to least impact on the score. You can attain the greatest efficiency gains by addressing the issues at the top of the list first.

Each factor is assigned a severity of High, Medium, or Low depending on the degree to which it decreases the app’s efficiency.

Note: This page only displays the factors that detract from your app’s performance. Factors are not listed if they are evaluated favorably for your app. See Efficiency score factors for a complete list of factors included in the analysis.

If the efficiency score is 100, the Negative Efficiency Factors list will be empty because the evaluation found no issues. The list can also be empty if the score is in the Good range. As Docusign refines its analysis, it may identify areas that can be improved even for relatively efficient apps. So, if you see a Good rating with no factors listed, please check the API Usage Center again in the coming weeks for updates to the factor list.

To see a more detailed description of any factor in the list and recommendations for addressing it, select the See Recommendations button in that row, which launches a window like the one shown below.

If you make app changes, the factor list can take up to eight days to reflect the change. This is because the efficiency evaluation is based on API activity over the previous seven days.

Next steps

• See Build a Docusign integration for more information about creating apps and integration keys.
• See API resource limits for more information about each API’s call limits.
• See API Dashboard for information about another dashboard that can help you monitor app performance.