AvantGuard - DNSFilter icon

AvantGuard - DNSFilter

AvantGuard - DNSFilter

Actions277

Overview

This node operation, Traffic Reports Total Organizations Requests, retrieves aggregated traffic report data for organizations. It is designed to query detailed network traffic statistics filtered by various criteria such as agents, applications, categories, domains, and time ranges. This node is useful for network administrators or security analysts who want to analyze total request counts across multiple organizations, helping them monitor network usage patterns, detect anomalies, or generate compliance reports.

Practical examples include:

  • Fetching total allowed and blocked web requests per organization over the last week.
  • Filtering traffic reports by specific user agents or application names to understand their network impact.
  • Generating threat-related reports by enabling the security report flag to identify potential security incidents.

Properties

Name Meaning
Additional Query Parameters Optional filters and parameters to customize the traffic report query. These include:
- Agent Ids: Comma-separated list of user agent UUIDs (default all).
- Agent Types: Comma-separated list of user agent types.
- Application Ids: Comma-separated list of application IDs.
- Bucket Size: Aggregation bucket size; options are auto, 15min, or 1day.
- Category Ids: Comma-separated list of category IDs.
- Collection Ids: Comma-separated list of collection IDs.
- Domain: Filter domains starting with this value.
- Fqdn: Filter fully qualified domain names containing this value.
- From: UTC start datetime for the report (format YYYY-MM-DDThh:mm:ss or with Z).
- Msp Id: Managed Service Provider ID.
- Name: Filter applications whose display name contains this value.
- Network Ids: Comma-separated list of network IDs.
- Organization Id: Single organization ID (defaults to user's organization).
- Organization Ids: Comma-separated list of organization IDs.
- Security Report: Boolean to filter threats only (true), non-threats only (false), or both if empty.
- To: UTC end datetime for the report.
- Type: Type of report; options are all, allowed, or blocked.
- User Ids: Comma-separated list of user IDs.

Output

The node outputs JSON data representing the aggregated traffic report results based on the specified filters. The structure typically includes metrics such as total request counts, categorized by organization and possibly further broken down by time buckets, agent types, or other dimensions depending on the query parameters.

If binary data output is supported, it would represent downloadable report files or raw data exports, but this is not indicated in the provided code or properties.

Dependencies

  • Requires an API key credential for authenticating with the external traffic reporting service.
  • The node uses a base URL endpoint (not explicitly shown here) to send HTTP requests with query parameters constructed from the input properties.
  • Proper configuration of the API authentication token or key within n8n credentials is necessary.

Troubleshooting

  • Common Issues:

    • Invalid date formats for from and to parameters may cause the API to reject the request or return default date ranges.
    • Providing incorrect or unauthorized organization IDs could result in empty responses or permission errors.
    • Omitting required authentication credentials will prevent successful API calls.
  • Error Messages:

    • Authentication failures usually indicate missing or invalid API keys; ensure credentials are correctly set up.
    • Validation errors on query parameters might mention unsupported values for bucket size or unknown IDs; verify parameter correctness.
    • Network or timeout errors suggest connectivity issues; check internet access and API availability.

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 how to configure API credentials and use HTTP request nodes for custom integrations.

Discussion