Actions71
- Settings Actions
- Subscribers Actions
- Create Subscriber
- Manage Subscriber Lists By Query
- Get Subscribers
- Delete Subscriber By List
- Get Subscriber By Id
- Update Subscriber By Id
- Delete Subscriber By Id
- Manage Subscriber Lists
- Manage Subscriber List By Id
- Manage Blocklist By Subscriber List
- Manage Blocklist Subscribers By Id
- Export Subscriber Data By ID
- Get Subscriber Bounces By Id
- Delete Subscriber Bounces By Id
- Subscriber Send Optin By Id
- Delete Subscriber By Query
- Blocklist Subscribers Query
- Bounces Actions
- Import Actions
- Campaigns Actions
- Update Preview Campaign By Id
- Get Campaigns
- Create Campaign
- Get Campaign By Id
- Update Campaign By Id
- Delete Campaign By Id
- Get Running Campaign Stats
- Get Campaign Analytics
- Preview Campaign By Id
- Preview Campaign Text By Id
- Update Campaign Status By Id
- Update Campaign Archive By Id
- Create Campaign Content By Id
- Test Campaign By Id
- Media Actions
- Templates Actions
- Public Actions
- Miscellaneous Actions
- Admin Actions
- Logs Actions
- Lists Actions
- Transactional Actions
- Maintenance Actions
Overview
This node operation retrieves campaigns from the Listmonk API. It allows users to filter campaigns by various criteria such as status, tags, and custom SQL queries, and supports pagination and sorting options. This is useful for scenarios where users need to manage or analyze marketing campaigns programmatically, for example, fetching active campaigns for reporting or filtering campaigns by tags for targeted processing.
Use Case Examples
- Fetch all active campaigns sorted by creation date.
- Retrieve campaigns tagged with 'newsletter' and 'promotion'.
- Get a specific page of campaigns with a custom number of items per page.
Properties
| Name | Meaning |
|---|---|
| Status | Filter campaigns by their status. Multiple statuses can be specified by repeating the parameter. |
| No Body | When true, the response will be returned without body content. |
| Page | Page number for paginated results. |
| Per Page | Number of items per page or 'all' to retrieve all results. |
| Tags | Filter campaigns by tags. Multiple tags can be specified by repeating the parameter. |
| Order | Sort order of results, either ascending (ASC) or descending (DESC). |
| Order By | Field by which to sort campaigns. Options include 'name', 'status', 'created_at', and 'updated_at'. |
| Query | SQL query expression to filter campaigns by custom criteria. |
| Request Options | Additional request settings such as batching, SSL handling, proxy, and timeout. |
Output
JSON
id- Unique identifier of the campaign.name- Name of the campaign.status- Current status of the campaign.created_at- Timestamp when the campaign was created.updated_at- Timestamp when the campaign was last updated.tags- Tags associated with the campaign.other_campaign_fields- Other relevant campaign details as returned by the API.
Dependencies
- Listmonk API
Troubleshooting
- Ensure the API base URL and credentials are correctly configured to avoid authentication errors.
- If the response is empty or missing expected data, verify the query parameters and filters are correctly set.
- Timeout errors may occur if the server is slow; adjust the timeout setting in request options accordingly.
- SSL certificate issues can be bypassed by enabling the 'Ignore SSL Issues' option, but use with caution.
Links
- Listmonk API Documentation - Official documentation for the Listmonk API, detailing endpoints and parameters.