3CX icon

3CX

Interact with 3CX telephony system
Join our community

Actions462

Overview

The "Get Audit Log Data" operation of the "Report Audit Log" resource allows users to retrieve audit log entries from the 3CX telephony system. This node is useful for monitoring and analyzing system events, user activities, or changes within the 3CX environment. It supports filtering, searching, sorting, and pagination of audit log data, enabling users to tailor the output to their specific needs.

Practical examples include:

  • Fetching the most recent 10 audit log entries to review recent system activity.
  • Searching audit logs for specific keywords or phrases related to a particular event.
  • Filtering audit logs by state or other properties to focus on relevant records.
  • Ordering audit logs by creation date to analyze trends over time.

Properties

Name Meaning
Options A collection of query parameters to customize the audit log retrieval:
$top Show only the first n items (pagination limit).
$skip Skip the first n items (pagination offset).
$search Search items by search phrases. If the phrase contains spaces and is not already quoted, it will be automatically quoted.
$filter Filter items by property values using OData filter syntax (e.g., State eq 'Connected').
$count Include count of total items in the response (boolean).
$select Select specific properties to be returned (comma-separated list, e.g., Id,Name).
$orderby Order items by property values (e.g., Name desc, CreatedAt asc).
$expand Expand related entities to include additional linked data (comma-separated list).

Output

The node outputs JSON data representing the audit log entries retrieved from the 3CX system. The structure typically includes an array of audit log objects with properties depending on the selected fields ($select) and expanded entities ($expand). If the $count option is enabled, the output also includes the total count of matching items.

If binary data were involved (not indicated here), it would represent attachments or related files, but this node focuses on JSON audit log data only.

Dependencies

  • Requires an API key credential for authenticating with the 3CX telephony system.
  • The base URL for the 3CX API must be configured in the node credentials.
  • The node sends HTTP requests to the 3CX API endpoint /xapi/v1 with appropriate query parameters based on user input.

Troubleshooting

  • Common issues:
    • Incorrect or missing API credentials will cause authentication failures.
    • Invalid filter or query syntax may result in API errors or empty responses.
    • Requesting too many items without pagination ($top and $skip) might lead to performance issues or timeouts.
  • Error messages:
    • Authentication errors usually indicate invalid or expired API tokens; re-authenticate or update credentials.
    • Query parameter errors suggest malformed OData queries; verify syntax and supported fields.
    • Network errors may require checking connectivity or API server status.

Links and References

Discussion