AvantGuard - DNSFilter icon

AvantGuard - DNSFilter

AvantGuard - DNSFilter
Join our community

Actions277

Overview

This node operation, Traffic Reports Total Collections Users, retrieves aggregated traffic report data focused on user collections. It is designed to query detailed traffic statistics such as allowed or blocked traffic, grouped by users, over a specified time range and filtered by various criteria like agent types, network IDs, or application IDs.

Typical use cases include:

  • Monitoring total traffic collections per user in an organization.
  • Analyzing security-related traffic reports (threats vs non-threats).
  • Filtering traffic data by specific agents, networks, or applications.
  • Generating time-bucketed traffic summaries for reporting or alerting.

For example, a network administrator could use this node to generate a daily report of all blocked traffic by user agents within the last week, helping identify potential security threats or policy violations.

Properties

Name Meaning
Additional Query Parameters Optional filters and parameters to customize the traffic report query. Includes:
- Agent Ids: Comma separated list of user agent UUIDs (default all)
- Agent Types: Comma separated list of user agent types (default all)
- Application Ids: Comma separated list of application IDs (default all)
- Bucket Size: Desired bucket size for aggregation (auto, 15min, 1day), default auto
- Collection Ids: Comma separated list of collection IDs (default all)
- From: Report start datetime in UTC (format YYYY-MM-DDThh:mm:ss or with Z)
- Mac Addresses: Comma separated MAC addresses without colons (default all)
- Network Ids: Comma separated list of network IDs (default all)
- Organization Ids: Comma separated list of organization IDs (default current user org)
- Private Ip: Private LAN IP filter
- Private Ip From/To: Range for private LAN IPs
- Security Report: Boolean to filter threats report (true for threats only, false for non-threats, empty for both), default true
- Show Individual Users: Boolean to group results by user ID, default true
- Source: Traffic source filter with options all, networks, agents, proxies, default all
- To: Report end datetime in UTC (format YYYY-MM-DDThh:mm:ss or with Z)
- Type: Type of report with options all, allowed, blocked, default all
- User Ids: Comma separated list of local user IDs (default all)

Output

The node outputs JSON data representing the aggregated traffic report based on the applied filters and parameters. The structure typically includes:

  • Aggregated traffic metrics grouped by user or other dimensions depending on the show_individual_users flag.
  • Time-bucketed data according to the bucket_size parameter.
  • Details about allowed, blocked, or all traffic types.
  • Security threat indicators if security_report is enabled.

If binary data output is supported, it would represent raw report files or exports, but this node primarily returns structured JSON data.

Dependencies

  • Requires an API key credential for authenticating requests to the AvantGuard DNSFilter service.
  • The node uses the base URL https://api.dnsfilter.com for its API calls.
  • Proper configuration of the API authentication credential in n8n is necessary.

Troubleshooting

  • Invalid Date Format: If the from or to date parameters are not in the correct ISO 8601 format, the API may reject the request or return unexpected results. Ensure dates follow YYYY-MM-DDThh:mm:ss or YYYY-MM-DDThh:mm:ssZ.
  • Empty or Incorrect Filters: Providing invalid IDs or malformed comma-separated lists can cause no data to be returned or errors. Double-check filter values.
  • Authentication Errors: Missing or incorrect API credentials will result in authorization failures. Verify that the API key credential is correctly set up.
  • Large Data Sets: Requesting very large date ranges or broad filters without bucket sizing may lead to performance issues or timeouts. Use appropriate bucket_size and filters to limit data volume.
  • Boolean Parameter Confusion: The security_report boolean defaults to true. Setting it incorrectly might exclude desired data. If unsure, try leaving it empty to get both threats and non-threats.

Links and References

Discussion