Listmonk Tool icon

Listmonk Tool

AI-optimized tool for managing email marketing with Listmonk. Call this tool to create subscribers, send emails, manage campaigns, and handle email marketing operations through natural language.

Actions8

Get Campaign Statistics

AI-generated

Overview

The node provides an interface to interact with Listmonk, an email marketing platform. Specifically, the "Get Campaign Statistics" operation retrieves detailed statistics for a specified email campaign by its ID. This is useful for marketers and automation workflows that need to monitor campaign performance metrics such as open rates, click rates, and other engagement data.

Practical examples include:

  • Automatically fetching campaign stats after sending an email campaign to update dashboards.
  • Triggering follow-up actions based on campaign performance (e.g., resending to non-openers).
  • Integrating campaign analytics into CRM or reporting tools.

Properties

Name Meaning
Campaign ID The unique numeric identifier of the campaign for which statistics are requested.

Output

The output JSON contains the statistics data returned from the Listmonk API endpoint /campaigns/{campaignId}/stats. This typically includes various metrics related to the campaign's performance, such as:

  • Number of emails sent
  • Open count and open rate
  • Click count and click rate
  • Bounce count
  • Unsubscribe count
  • Other engagement-related statistics

The exact structure depends on Listmonk's API response format for campaign stats.

No binary data output is involved in this operation.

Dependencies

  • Requires connection to a Listmonk instance via its REST API.
  • Needs credentials including domain URL, username, and password for basic authentication.
  • The node expects the Listmonk API to be accessible at the configured domain under the /api path.

Troubleshooting

  • Invalid Campaign ID: If the provided campaign ID does not exist or is invalid, the API will likely return an error. Ensure the campaign ID is correct and corresponds to an existing campaign.
  • Authentication Errors: Incorrect or missing API credentials will cause authentication failures. Verify the API username and password are correctly set in the node credentials.
  • Network Issues: Connectivity problems to the Listmonk server can cause request failures. Check network access and firewall settings.
  • API Endpoint Changes: If Listmonk updates their API, the node might fail to retrieve stats. Confirm compatibility with the current Listmonk API version.

Links and References

Discussion