API Request Logging

If you are using an API Integration with DocuSign outside of regular DocuSign tools, administrators may now download API requests associated with their integration directly through the DocuSign Web Application. This is particularly useful when troubleshooting specific issues within an integration, or if DocuSign Support requests an API trace log.

You must be a DocuSign Administrator to enable and use this feature.

 

Enabling API Request Logging - Classic DocuSign Experience

To enable this feature, follow these steps:

  1. Log in to your DocuSign account and click the Profile image.
  2. Click Preferences.
  3. Under Member Options, click Permissions.
  4. On the Permissions Page, under the DocuSign API section, click to check Enable API Request Logging.
  5. Click Save.

All calls associated with your DocuSign integration API User ID will now be logged.

Note: The maximum number of calls recorded is limited to 50. To track the most recent calls after the first 50, click the Clear API Request Logs button.

Downloading API Requests Logs

To download the logs, from the Permissions screen, click Download API Requests Logs.

The request logs are delivered in a ZIP file which contains a text file named after each call made to the DocuSign API, as well as the subsequent response. The request file names are prepended with the number in which it was created, e.g., 00_Created_CreateEnvelopeFromTemplatesAndForms.txt. The response files are prepended with the system response code, e.g., 01_OK_RequestTemplates.txt.

Note: All times associated with the log files are in UTC; if you use a different time zone the file timestamps will not match your system settings.

Note: The request header information is included in the file; however, the password and integrator key are automatically redacted for security purposes.