3CX icon

3CX

Interact with 3CX telephony system
Join our community

Actions462

Overview

The node provides functionality to download audit logs from a reporting system, specifically under the "Report Audit Log" resource with the "Download Audit Log" operation. It allows users to retrieve audit log data filtered and customized by various query parameters such as pagination, search, filtering, selection of fields, ordering, and expansion of related entities.

This node is beneficial in scenarios where an organization needs to programmatically access audit trail information for compliance, monitoring, or troubleshooting purposes. For example, a user might want to download audit logs filtered by a specific time range or user activity, or limit the number of records returned for performance reasons.

Properties

Name Meaning
Client Time Zone The client’s time zone used in the request, required to correctly interpret date/time values.
Options A collection of optional 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; supports automatic quoting if phrase contains spaces.
- Filter Filter items by property values using expressions (e.g., State eq 'Connected').
- Count Include count of total items matching the query (boolean).
- Select Select specific properties/fields to be returned (comma-separated list).
- 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 according to the specified parameters. Each item corresponds to an audit log record with properties depending on the API response and any $select options applied.

If binary data were involved (not indicated here), it would typically represent downloadable files or attachments related to the audit logs, but this node focuses on JSON data output.

Dependencies

  • Requires an API key or OAuth2 authentication token configured in n8n credentials to authenticate requests to the audit log service.
  • The base URL for the API endpoint must be configured in the credentials or node settings.
  • The node sends HTTP requests with query parameters based on the input properties.

Troubleshooting

  • Missing or invalid Client Time Zone: The node requires a valid client time zone string; ensure this is provided to avoid errors related to date/time parsing.
  • Invalid filter or query syntax: If the $filter, $search, or other query parameters are malformed, the API may return errors. Validate expressions against the API documentation.
  • Authentication errors: Ensure that the API key or OAuth2 credentials are correctly set up and have sufficient permissions to access audit logs.
  • Empty results: If no data is returned, verify the filter criteria and pagination parameters to ensure they match existing audit log entries.

Links and References

  • Refer to the official API documentation of the audit log service for detailed descriptions of supported query parameters and their syntax.
  • n8n documentation on how to configure credentials and use HTTP request nodes for similar integrations.

Discussion