Instantly icon

Instantly

Interact with Instantly API

Actions24

Overview

This node interacts with the Instantly API to retrieve analytics data related to marketing campaigns. Specifically, the "Get Campaign Analytics" operation fetches performance metrics for one or more campaigns over a specified date range. This is useful for marketers and analysts who want to monitor campaign effectiveness, track engagement, and optimize their outreach strategies.

Practical examples include:

  • Retrieving detailed analytics for a specific campaign to evaluate its success.
  • Fetching analytics for all campaigns to generate comprehensive reports.
  • Filtering analytics data by start and end dates to analyze performance within a particular timeframe.

Properties

Name Meaning
Return All Whether to return analytics for all campaigns (true) or just the selected campaign (false).
Campaign The specific campaign to get analytics for. Can be selected from a list of campaigns or specified by ID. Required if "Return All" is false.
Start Date The start date (YYYY-MM-DD) for filtering analytics data. Leave empty to include all data from the beginning.
End Date The end date (YYYY-MM-DD) for filtering analytics data. Leave empty to include all data up to the latest available.

Output

The node outputs JSON data containing the analytics information retrieved from the Instantly API. The structure typically includes various campaign performance metrics such as impressions, clicks, conversions, and other relevant statistics depending on the API response.

If "Return All" is enabled, the output will be an array of analytics objects for all campaigns; otherwise, it will contain analytics for the specified campaign only.

No binary data output is indicated in the source code.

Dependencies

  • Requires an API key credential for authenticating requests to the Instantly API.
  • The node depends on the Instantly API endpoints /api/v2/campaigns and the analytics-related endpoints accessed via the OperationRouter.
  • No additional environment variables are explicitly required beyond the API authentication setup.

Troubleshooting

  • Common Issues:

    • Invalid or missing API credentials will cause authentication failures.
    • Specifying a campaign ID that does not exist or is inaccessible may result in empty or error responses.
    • Incorrect date formats for "Start Date" or "End Date" could lead to request errors or no data returned.
    • Network issues or API downtime can cause request failures.

  • Error Messages:

    • Errors thrown during execution will be captured and returned as JSON with an error field if "Continue On Fail" is enabled.
    • Typical error messages might include authentication errors, invalid parameter errors, or rate limit exceeded messages.

  • Resolutions:

    • Verify API credentials and permissions.
    • Ensure campaign IDs are correct and accessible.
    • Use valid ISO date strings for date filters.
    • Check network connectivity and API status.

Links and References

Discussion