API Transaction Log

The API Transaction Log tracks API activities with filtering, exporting, column customization, date range filters, and report generation tools.

The API Transaction Log window in AlphaX Cloud is a centralized tool for monitoring API activities. It offers features like filtering by IP address or request, customizable columns, export options, and date range filters. With tools for report generation and pagination controls, it ensures efficient analysis and management of API transactions, enhancing operational transparency and system insights.

API Transaction Log View

Key Features of the System Application Logs View

1. Top Section

Element
Description

Header

Displays the title "System Application Logs"

Entries Info

Indicates the number of log entries currently displayed, such as "Showing 1 to 100 of 155 entries".

Report Button

This button allows users to create a new service log report.

2. Log Tabs

The logs are categorized into four distinct tabs, allowing users to switch between different types of log data.

Tab
Description

System Log

Displays logs related to system activities and changes.

Email Message Log

Shows logs of email activities, such as sent or failed emails.

SMS Message Log

Contains logs for SMS communication, including sent and failed messages.

API Transaction Log

Logs transactions related to API calls.

3. Filter and Additional Controls

Element
Description

Filter Button

Allows users to filter log entries by specific criteria, such as keywords or user actions.

Additional Buttons

Four buttons located on the top-right corner of the logs table for added functionality:

1. Date Range

Enables users to select a specific date range for filtering log entries.

2. Column Visibility

Lets users toggle the visibility of table columns to customize the view.

3. Export

Allows exporting log data in various formats (e.g., CSV, Excel, or PDF).

4. Maximize

Expands the log table to full screen for a better view of detailed data.

Explanation of the Date Range Button

The Date and Time Range Button provides an intuitive way to filter log data by time periods, offering both predefined and custom range options. With Apply and Cancel buttons, it ensures accuracy and flexibility in refining log entries for analysis.

Features of the Date and Time Range Button

Feature
Description

Predefined Time Ranges

- Users can quickly select commonly used time ranges, such as: - Last 1 Hour - Last 24 Hours - Last 48 Hours - Last 7 Days - Last 30 Days - Last 90 Days

Custom Date and Time Range

- Users can define a custom time range: - Use the calendar to select a start date and end date. - Specify exact times using the hour and minute dropdowns. - Example: Filter logs from 2024-12-02 15:26 to 2024-12-02 16:26.

Apply Button

After selecting a date and time range: - Click Apply to filter logs and update the table with the selected range. - Only logs within the range will be displayed.

Cancel Button

- If the range is incorrect: - Click Cancel to reset the selection. - Users can reselect the correct date and time range before applying.

Steps to Use the Date and Time Range Button

Step
Action

Step 1

Click the Date and Time Range Button to open the date and time picker.

Step 2

Select a predefined range or choose a custom range: - For predefined ranges, click the desired option. - For custom ranges, use the calendar and dropdowns to set a start and end date with specific times.

Step 3

Click Apply to filter the logs based on the selected range.

Step 4

f the selection is incorrect, click Cancel to reset and select the correct date and time range.

4. Logs Table

The logs are displayed in a tabular format with the following columns.

Column Name
Description

Timestamp

Displays the date and time of the transaction, with sorting options (ascending or descending order).

Site

Shows the name of the site associated with the API transaction.

IP Address

Lists the IP address from which the API request originated.

Request

Provides the API endpoint or URL accessed in the transaction.

Trans ID

A unique transaction identifier for tracking and referencing the API call.

5. Pagination Controls

Element
Description

Pagination Buttons

These buttons allow users to : * Navigate between pages of log entries. * View more or fewer entries per page by adjusting the pagination settings.

Conclusion

The API Transaction Log window in AlphaX Cloud provides a comprehensive and user-friendly interface for monitoring and managing API-related transactions. With features such as filtering by IP address or request, customizable columns, export options, and date range filters, it ensures efficient data analysis and log management. The report generation and pagination controls enhance usability, making it an essential tool for tracking API activities effectively.

Last updated