Articles in this section
Category / Section

How to view all API logs in the developer console as an account admin?

Published:
2 mins read

As an account admin, you have the option to access and monitor API logs in the developer console. This feature allows you to review the API activities conducted by users within your organization. This knowledge base article provides step-by-step instructions on how to efficiently utilize the API log viewing capabilities, including filtering options based on users and credentials.

Accessing the developer console

  • Log into your account.
  • Navigate to the API section and click Developer Console to view the API logs.

Developer Console

Filter by users

  • To view API logs for a specific user, use the provided user filters.
  • Select the desired user(s) from the dropdown menu.

Select users from the dropdown menu

  • The API log display will automatically update to show API logs exclusively related to the selected user(s).

Filtered logs from the selected users

  • You can also select All to view logs for all users who have access to the API credentials in the organization.

Filter by credentials

In BoldSign, users can make API requests using two types of credentials: API Key and OAuth. As an Account Admin, you can filter the API logs based on the credentials used by the users.

  • To focus on API logs associated with specific credentials, utilize the credentials filter.
  • Choose a user first to narrow down the scope.

Select users from the dropdown menu

  • In the credentials section, select the desired credential(s) from the dropdown.

Select credentials from the dropdown menu

  • The API log display will adjust to show logs only for the selected user and credentials.

Filtered logs from the selected users and credentials

  • You can also select All to view logs for all credentials used by the selected user(s).

Filter by environment

You can also filter the API logs based on the environment (Sandbox and Live). You can switch the environment from the top left corner of the developer console page.

Environment switch

After switching the environment, the API logs will be updated to show the logs for the selected environment, and the credentials dropdown will only show the credentials for the selected environment.

Other filters

You can also filter the API logs based on the following:

  • Status (All, Success, Failure)
  • Date range

Download API logs

The developer console also offers the option to download the API logs in JSON format, containing all data related to API requests, responses, files, and more. You can utilize this data for further analysis or record-keeping purposes by clicking the Download logs button.

Download logs button

Was this article useful?
Like
Dislike
Help us improve this page
Please provide feedback or comments
Access denied
Access denied