Listmonk icon

Listmonk

Interact with a listmonk instance for email marketing and newsletter management. Supports creating subscribers, managing campaigns, sending emails, and more.

Actions32

Campaign → Get Stats by ID

AI-generated

Overview

The node integrates with a listmonk instance, an email marketing and newsletter management platform. Specifically, the "Get Stats by ID" operation under the "Campaign" resource retrieves statistical data for a particular campaign identified by its unique numeric ID. This is useful for users who want to monitor the performance of their email campaigns, such as open rates, click rates, or other engagement metrics.

Practical examples include:

  • Fetching campaign statistics after sending a newsletter to analyze recipient engagement.
  • Automating reports on campaign effectiveness by retrieving stats programmatically.
  • Integrating campaign performance data into dashboards or CRM systems.

Properties

Name Meaning
ID The unique identifier of the campaign whose statistics you want to retrieve. Must be a valid number.

Output

The output contains a JSON object representing the statistics of the specified campaign. This typically includes various metrics related to the campaign's performance, such as the number of emails sent, opened, clicked, bounced, etc. The exact structure depends on the listmonk API response but generally provides detailed insights into how the campaign performed.

If the node supports binary data output (not indicated here), it would typically relate to attachments or media associated with the campaign stats, but this operation focuses on JSON data only.

Dependencies

  • Requires connection to a listmonk instance via its API.
  • Needs credentials including domain URL, username, and password for authentication.
  • The node expects these credentials to be configured in n8n beforehand.
  • The base URL for API requests is constructed from the provided domain credential.

Troubleshooting

  • Invalid ID error: If the provided campaign ID is not a valid number or does not exist, the node may return an error indicating the campaign was not found. Ensure the ID is correct and corresponds to an existing campaign.
  • Authentication errors: Incorrect or missing credentials will cause authentication failures. Verify that the API credentials are correctly set up in n8n.
  • Network issues: Connectivity problems with the listmonk server can cause request failures. Check network access and the availability of the listmonk instance.
  • API changes: If the listmonk API changes, the node might fail to parse responses correctly. Keep the node updated with the latest version compatible with your listmonk instance.

Links and References

Discussion