AvantGuard - DNSFilter icon

AvantGuard - DNSFilter

AvantGuard - DNSFilter

Actions277

Overview

The "Traffic Reports Qps" operation under the "Traffic Reports" resource is designed to retrieve detailed traffic query-per-second (QPS) reports from a network monitoring or security service. This node allows users to specify various filters and parameters to customize the traffic data they want to analyze, such as filtering by user agents, applications, networks, IP ranges, and time intervals.

This node is beneficial in scenarios where network administrators or security analysts need to monitor traffic patterns, detect anomalies, or generate usage statistics over specific periods. For example, it can be used to:

  • Analyze traffic volume trends for different user agents or applications.
  • Monitor allowed versus blocked traffic types.
  • Generate threat-related reports by toggling security report options.
  • Group results by individual networks for granular insights.

Properties

Name Meaning
Additional Query Parameters A collection of optional query parameters to refine the traffic report request:
- Agent Ids: Comma-separated list of user agent UUIDs; defaults to all.
- Agent Types: Comma-separated list of user agent types; defaults to all.
- Application Ids: Comma-separated list of application IDs; defaults to all.
- Bucket Size: Desired bucket size for aggregation (auto, 1min, 15min, 1day); defaults to auto with automatic adjustment based on date range.
- Collection Ids: Comma-separated list of collection IDs; defaults to all.
- From: UTC lower limit datetime for the report in ISO format; defaults to current UTC minus 1 day.
- Mac Addresses: Comma-separated list of MAC addresses (without colons); defaults to all.
- Msp Id: Managed Service Provider ID; default is 0.
- Nat Ips: Comma-separated list of NAT IPs (valid integers 101 to 106); defaults to all.
- Network Ids: Comma-separated list of network IDs; defaults to all.
- Organization Ids: Comma-separated list of organization IDs; defaults to user's organization ID.
- Private Ip: Private LAN IP address.
- Private Ip From: Lower limit of private LAN IP range.
- Private Ip To: Upper limit of private LAN IP range.
- Security Report: Boolean to include threats report; true includes threats, false excludes, empty includes both.
- Show Individual Networks: Boolean to group results by network ID; defaults to true.
- Source: Traffic source filter with options: all, networks, agents, proxies; defaults to all.
- To: UTC upper limit datetime for the report in ISO format; defaults to current UTC.
- Type: Type of report with options: all, allowed, blocked; defaults to all.
- User Ids: Comma-separated list of local user IDs; defaults to all.

Output

The node outputs JSON data representing the traffic QPS report according to the specified filters and parameters. The structure typically includes aggregated traffic metrics grouped by the chosen bucket size and filtered by the selected criteria. The output may contain fields such as timestamps, counts of allowed or blocked traffic, threat indicators if enabled, and grouping by networks or other entities.

If binary data were involved (e.g., files or images), it would be summarized accordingly, but this node primarily returns structured JSON data.

Dependencies

  • Requires an API key credential for authenticating requests to the underlying traffic reporting service.
  • The node sends HTTP requests to a predefined base URL endpoint (not explicitly shown in the provided code but implied by the use of query parameters).
  • Proper configuration of the API authentication token or key within n8n credentials is necessary.

Troubleshooting

  • Invalid Date Format: If the from or to date parameters are not in the correct ISO format (YYYY-MM-DDThh:mm:ss or YYYY-MM-DDThh:mm:ssZ), the node may default to fallback dates or return errors. Ensure date strings are correctly formatted.
  • Empty or Incorrect Filters: Providing invalid or empty comma-separated lists (e.g., malformed UUIDs or IPs) might result in no data returned or errors. Validate input values before execution.
  • API Authentication Errors: Missing or incorrect API keys will cause authentication failures. Verify that the API key credential is properly set up in n8n.
  • Unsupported Bucket Size: Using unsupported bucket sizes outside the allowed options (auto, 1min, 15min, 1day) may lead to errors or unexpected aggregation behavior.
  • Network or Permission Issues: Network connectivity problems or insufficient permissions on the API side can cause request failures.

Links and References

  • Refer to the official API documentation of the traffic reporting service for detailed descriptions of query parameters and response formats.
  • n8n documentation on creating and using API key credentials.
  • General best practices for date/time formatting in ISO 8601 standard.

Discussion