AvantGuard - CIPP icon

AvantGuard - CIPP

AvantGuard - CIPP

Actions136

Overview

This node operation, "Retrieve List Message Trace," is designed to fetch detailed message trace information related to a specific list within the AvantGuard - CIPP system. It allows users to query message traces by specifying parameters such as the number of days to look back, identifiers for the list and messages, sender and recipient details, tenant filters, and trace detail levels.

Typical use cases include:

  • Auditing message delivery and status for compliance or troubleshooting.
  • Monitoring communication flows within mailing lists.
  • Investigating message tracebacks for specific recipients or senders over a defined period.

For example, a user might retrieve all message traces sent from a particular sender to a recipient within the last 7 days to verify delivery success or diagnose issues.

Properties

Name Meaning
Days Number of days in the past to include in the message trace search (e.g., "7" for last week).
Id Identifier of the list or message to retrieve trace information for.
Recipient Email address or identifier of the message recipient to filter the trace results.
Sender Email address or identifier of the message sender to filter the trace results.
Tenantfilter Filter parameter to specify the tenant context for the trace retrieval.
Tracedetail Level of detail required in the trace output (e.g., summary or full detailed trace).

Output

The node outputs JSON data containing the message trace information matching the specified query parameters. The structure typically includes details about each traced message such as timestamps, sender and recipient info, message status, and any relevant metadata returned by the AvantGuard - CIPP API.

If binary data were involved (e.g., attachments), it would be indicated here, but based on the provided code and properties, the output is purely JSON with message trace details.

Dependencies

  • Requires an API key credential for authenticating with the AvantGuard - CIPP service.
  • Needs configuration of the base URL for the AvantGuard resource API endpoint.
  • Depends on the @avantguardllc/n8n-openapi-node package and the associated OpenAPI specification (openapi.json) bundled with the node.

Troubleshooting

  • Missing or invalid credentials: Ensure that the API key credential is correctly configured and has sufficient permissions.
  • Incorrect property values: Verify that all required properties (Days, Id, Recipient, Sender, Tenantfilter, Tracedetail) are provided and valid.
  • API connectivity issues: Check network access to the configured AvantGuard API URL and confirm the service is operational.
  • Empty or unexpected responses: Confirm that the query parameters match existing data; adjust filters if no results are returned.

Common error messages may relate to authentication failures, invalid query parameters, or timeouts. Resolving these usually involves checking credentials, input correctness, and network conditions.

Links and References

Discussion