AvantGuard - DNSFilter icon

AvantGuard - DNSFilter

AvantGuard - DNSFilter
Join our community

Actions277

Overview

This node operation, Traffic Reports Total Requests Organizations, retrieves aggregated traffic report data grouped by organizations. It is designed to provide insights into network traffic requests across multiple organizations, including details such as allowed or blocked requests, sources of traffic, and time-based buckets.

Typical use cases include:

  • Network administrators wanting to monitor total traffic requests per organization over a specified period.
  • Security teams analyzing threat-related traffic reports.
  • MSPs (Managed Service Providers) aggregating traffic data across their managed organizations.
  • Reporting tools that require detailed traffic metrics segmented by various filters like user agents, networks, or applications.

For example, you could use this node to generate a daily summary of all blocked requests across your client organizations or analyze traffic patterns filtered by specific user agents or network IDs.

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 to filter by; defaults to all if empty.
- 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 grouping results. Possible values: auto, 15min, 1day. Defaults to auto which selects 15 minutes buckets for less than 24 hours range, otherwise 1 day.
- Collection Ids Comma separated list of collection IDs; defaults to all.
- From Report UTC lower limit datetime in format YYYY-MM-DDThh:mm:ss or YYYY-MM-DDThh:mm:ssZ. Defaults to current UTC datetime minus 1 day or ignored if format unrecognized.
- Mac Addresses Comma separated list of MAC addresses (without colons) or filter values; defaults to all.
- Msp Id Numeric MSP ID to filter reports by. Defaults to 0.
- Nat Ips Comma separated list of NAT IPs (valid integers from 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 the user's organization ID.
- Private Ip Specific private LAN IP to filter by.
- Private Ip From Lower limit of private LAN IP range.
- Private Ip To Upper limit of private LAN IP range.
- Security Report Boolean flag to filter threats report. true for threats only, false for non-threats only, or both if not set. Defaults to true.
- Show Individual Organizations Boolean flag to group report results by organization ID. Defaults to true.
- Source Traffic source filter. Options: all, networks, agents, proxies. Defaults to all.
- To Report UTC upper limit datetime in format YYYY-MM-DDThh:mm:ss or YYYY-MM-DDThh:mm:ssZ. Defaults to current UTC datetime or ignored if format unrecognized.
- Type Type of report filter. 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 aggregated traffic report grouped by organizations according to the applied filters. The structure typically includes:

  • Organization identifiers.
  • Time-bucketed counts of total requests.
  • Breakdown by request type (allowed, blocked).
  • Possibly threat-related flags if security report filtering is enabled.
  • Other metadata depending on the query parameters.

If binary data output is supported, it would represent raw report files or exports, but based on the provided code and properties, the output is primarily JSON structured data summarizing traffic requests.

Dependencies

  • Requires an API key credential for authenticating with the external traffic reporting service.
  • The node makes HTTP requests to the service's API endpoint (base URL not explicitly shown here but implied).
  • Proper configuration of credentials and network access to the API is necessary.

Troubleshooting

  • Invalid Date Format: If the from or to date parameters are incorrectly formatted, the API may default to fallback dates or return errors. Ensure dates follow the ISO 8601 format (YYYY-MM-DDThh:mm:ss or with trailing Z).
  • Empty or Incorrect Filters: Providing invalid IDs or malformed comma-separated lists may result in no data returned or API errors.
  • Authentication Errors: Missing or incorrect API key credentials will cause authentication failures.
  • API Rate Limits: Excessive requests might be throttled by the external service.
  • Boolean Parameter Misuse: The security_report and show_individual_organizations expect boolean values; passing strings or other types may cause unexpected behavior.

To resolve these issues:

  • Validate input formats carefully.
  • Check API credentials and permissions.
  • Review API documentation for rate limits and parameter constraints.

Links and References

Discussion