Listmonk icon

Listmonk

Interact with a listmonk instance

Overview

The node interacts with a Listmonk instance, specifically providing operations related to campaigns, including retrieving campaign statistics by ID. The "Get Stats by ID" operation fetches detailed statistical data for a specific campaign identified by its unique ID. This is useful for users who want to analyze the performance of their email campaigns, such as open rates, click rates, and other engagement metrics.

Practical examples include:

  • Retrieving campaign stats after sending an email blast to evaluate its effectiveness.
  • Integrating campaign performance data into dashboards or reports.
  • Automating follow-up actions based on campaign results.

Properties

Name Meaning
ID The unique identifier of the campaign whose statistics you want to retrieve. This is a required string input.

Output

The output contains a JSON object representing the statistics of the specified campaign. This typically includes various metrics such as the number of emails sent, opened, clicked, bounced, etc., reflecting the campaign's performance. The exact structure depends on the Listmonk API response but generally provides comprehensive campaign engagement data.

If the node supports binary data output (not indicated here), it would represent attachments or media related to the campaign stats, but this operation primarily returns JSON data.

Dependencies

  • Requires connection to a Listmonk instance via its API.
  • Needs credentials consisting of a domain URL, username, and password for authentication.
  • The node uses HTTP Basic Authentication to communicate with the Listmonk API.
  • Proper configuration of these credentials in n8n is necessary for successful operation.

Troubleshooting

  • Invalid or missing ID: If the provided campaign ID does not exist or is empty, the node will likely return an error indicating that the resource was not found. Ensure the ID is correct and corresponds to an existing campaign.
  • Authentication errors: Incorrect credentials or misconfigured API endpoint can cause authentication failures. Verify the domain URL, username, and password are correctly set.
  • Network issues: Connectivity problems between n8n and the Listmonk server may result in timeouts or unreachable host errors.
  • API changes: If the Listmonk API changes, some fields or endpoints might become deprecated, causing unexpected errors. Check the Listmonk API documentation for updates.

Links and References

Discussion