AvantGuard - DNSFilter icon

AvantGuard - DNSFilter

AvantGuard - DNSFilter

Actions277

Overview

The "Traffic Reports Top Users" operation in the "Traffic Reports" resource fetches a report listing the top users based on traffic data. This node is useful for network administrators or security analysts who want to analyze user activity, identify heavy users, or monitor traffic patterns within their network environment. It supports filtering by various parameters such as agent IDs, application IDs, time ranges, and more, allowing tailored reports.

Practical examples include:

  • Identifying which users generate the most network traffic during a specific period.
  • Filtering reports to see only blocked or allowed traffic types.
  • Narrowing down results to specific networks, organizations, or device types.

Properties

Name Meaning
Additional Query Parameters A collection of optional filters and query parameters to refine the report:
- 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)
- Collection Ids: Comma-separated list of collection IDs (default all)
- From: UTC lower limit datetime for the report (format YYYY-MM-DDThh:mm:ss or with Z), defaults to current UTC minus 1 day
- Mac Addresses: Comma-separated MAC addresses without colons (default all)
- Msp Id: MSP ID number
- Name: Filter local users whose name contains this value
- Nat Ips: Comma-separated NAT IPs (valid integers 101 to 106) (default all)
- Network Ids: Comma-separated network IDs (default all)
- Organization Ids: Comma-separated organization IDs (default user org ID)
- Page: JSON object specifying page number (default 1) and size (default 10, max 100)
- Private Ip: Private LAN IP
- Private Ip From: Lower limit of private LAN IP range
- Private Ip To: Upper limit of private LAN IP range
- Security Report: Boolean to filter threats report; true/false or both if empty (default true)
- Source: Traffic source filter with options: all, networks, agents, proxies (default all)
- To: UTC upper limit datetime for the report (format YYYY-MM-DDThh:mm:ss or with Z), defaults to current UTC
- 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 containing the traffic report of top users according to the specified filters. The structure typically includes user identifiers, traffic statistics, and possibly metadata about the traffic sources and types. The exact fields depend on the API response but generally provide detailed insights into user traffic behavior.

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

Dependencies

  • Requires an API key credential for authenticating requests to the external traffic reporting service.
  • The node sends HTTP requests to the service's API endpoint, so internet connectivity and proper API base URL configuration are necessary.
  • No additional environment variables are explicitly required beyond the API authentication setup.

Troubleshooting

  • Common issues:

    • Invalid date formats for the from and to parameters may cause the API to default to fallback dates or return errors.
    • Exceeding maximum page size (over 100) might be rejected by the API.
    • Providing malformed comma-separated lists (e.g., extra spaces or invalid characters) could lead to no results or errors.
    • Missing or invalid API credentials will result in authentication failures.
  • Error messages:

    • Authentication errors indicate missing or incorrect API keys; verify credentials.
    • Validation errors on query parameters suggest checking the format and allowed values, especially for date/time and enumerated options.
    • Network errors imply connectivity issues or incorrect base URL configuration.

Links and References

  • Refer to the official API documentation of the traffic reporting service for detailed parameter descriptions and response schemas.
  • Consult n8n documentation on how to configure API key credentials and use HTTP request nodes for similar integrations.

Discussion