Instantly icon

Instantly

Interact with Instantly API

Actions15

Overview

This node interacts with the Instantly API to retrieve analytics data related to email campaigns. Specifically, the "Get Campaign Analytics" operation fetches performance metrics for one or all campaigns within an optional date range. This is useful for marketing teams and sales professionals who want to monitor campaign effectiveness, track engagement over time, and optimize outreach strategies.

Practical examples include:

  • Fetching detailed analytics for a specific campaign to evaluate its success.
  • Retrieving aggregated analytics for all campaigns to compare performance.
  • Filtering analytics data by start and end dates to analyze trends during a particular period.

Properties

Name Meaning
Return All Whether to return analytics for all campaigns (true) or just the selected campaign (false).
Campaign The campaign to get analytics for. Choose from a searchable list of campaigns or specify a campaign ID.
Start Date Optional start date (YYYY-MM-DD) to filter analytics data from this date onward. Leave empty for no limit.
End Date Optional end date (YYYY-MM-DD) to filter analytics data up to this date. Leave empty for no limit.

Output

The node outputs JSON data containing the analytics information retrieved from the Instantly API. The structure depends on whether analytics for all campaigns or a single campaign is requested:

  • When returning all campaigns' analytics, the output is an array of analytics objects, each representing a campaign's metrics.
  • When returning analytics for a single campaign, the output is a JSON object with that campaign's analytics data.

The exact fields in the analytics data depend on the Instantly API response but typically include metrics such as opens, clicks, replies, bounces, and other campaign performance indicators.

No binary data output is produced by this node.

Dependencies

  • Requires an active Instantly API key credential configured in n8n to authenticate requests.
  • Relies on the Instantly API endpoints /api/v2/campaigns/analytics for fetching analytics data.
  • The node uses internal helper functions to handle pagination and date formatting.

Troubleshooting

  • Invalid Date Format: If the start or end date is not in YYYY-MM-DD format, the node will warn and ignore the invalid date. Ensure dates are correctly formatted.
  • Campaign Not Found: Specifying a campaign ID that does not exist or is inaccessible may result in an error or empty response. Verify the campaign ID or select from the provided list.
  • API Rate Limits or Errors: Network issues or API limits can cause request failures. Check your API key validity and network connectivity.
  • Limitations on Return All: When Return All is false, only the selected campaign's analytics are returned. Setting it to true returns analytics for all campaigns, which might be large and take longer to fetch.

Links and References

Discussion