Documentation for Administrators

API Logs

Updated on

The API Logs screen allows administrators to view external API usage and authentication activity. The report includes the Request Logs tab for reviewing API requests, including request details, response status, execution time, result counts, request payloads, and the consuming application. The Authentication Logs tab provides insight into API token generation and usage, including client information, expiration dates, and token activity.

Expand or collapse content Viewing the Request Logs

1. In the Reports menu, click API Logs.

2. In the Request Logs tab, enter report criteria to filter the report, if desired, including the Start Date, End Date, Method, Route, and Consumer.

3. Click Run Report.

The updated report is displayed, including the Date, Consumer, Method, Route, Status, Duration (ms), Results, Version, Dialect, Payload, and Error.

4. Click the Payload button to view payload information in a pop-up window.

a. Click the X to close the window, when finished.

Expand or collapse content Viewing the Authentication Logs

1. In the Reports menu, click API Logs.

2. Click the Authentication Logs tab.

API Logs

3. Enter report criteria to filter the report, if desired, including the Start Date, End Date, and Consumer.

4. Click Run Report.

API Logs

The updated report is displayed, including the Created date/time, Consumer, Client ID, Expiration date/time, and Uses.

API Logs
Expand or collapse content Additional Features

See Additional Features for more information on Exporting, Filtering, Toggle Columns, and more.

Previous Article Saved Reports
Next Article SSRS Reports