AvantGuard - Maileroo icon

AvantGuard - Maileroo

AvantGuard - Maileroo
Join our community

Actions5

Overview

The node provides functionality to list insights (analytics data) related to email links and domains. It allows users to retrieve detailed analytics filtered by various parameters such as date range, device type, browser, location, and more. This is useful for marketing teams or analysts who want to track the performance and engagement of their email campaigns by analyzing link clicks, device usage, geographic distribution, and other metrics.

Practical examples include:

  • Retrieving click statistics for a specific link over the past week.
  • Filtering analytics data by country or city to understand regional engagement.
  • Analyzing which devices or browsers are most commonly used to access email links.

Properties

Name Meaning
Additional Query Parameters Optional filters to refine the insight data returned. Includes:
- Date From Start date for data range (format YYYY-MM-DD). Defaults to 7 days before current date.
- Date To End date for data range (format YYYY-MM-DD). Defaults to current date.
- Timezone Timezone offset for returned data. Defaults to UTC.
- Link Specific link URL to filter analytics data.
- Domain Specific domain to filter analytics data.
- Device Device type filter (e.g., Desktop).
- Browser Browser filter (e.g., Chrome).
- OS Operating system filter (e.g., Windows).
- Country Country filter using ISO 3166 2-digit code (e.g., US).
- City City filter (e.g., Washington).
- Medium Medium filter (e.g., Click).
- Source Source filter (e.g., footer).

These parameters allow fine-grained control over the insight data retrieved.

Output

The node outputs JSON data containing the requested insight analytics based on the applied filters. The structure typically includes aggregated metrics and details about link clicks, user devices, locations, and time-based statistics.

If binary data were supported, it would represent downloadable reports or raw data files, but this node focuses on JSON analytics output.

Dependencies

  • Requires an API key credential for authentication with the external Maileroo analytics service.
  • Connects to the base URL https://smtp.maileroo.com to fetch insight data.
  • No additional environment variables are explicitly required beyond the API credential.

Troubleshooting

  • Common issues:
    • Invalid or missing API credentials will cause authentication failures.
    • Incorrect date formats in query parameters may result in errors or empty responses.
    • Overly restrictive filters might return no data; try broadening the query parameters.
  • Error messages:
    • Authentication errors indicate problems with the provided API key; verify and update credentials.
    • Validation errors on query parameters suggest incorrect formatting; ensure dates follow YYYY-MM-DD.
    • Network or timeout errors may require checking connectivity or retrying later.

Links and References

Discussion