AvantGuard - DNSFilter icon

AvantGuard - DNSFilter

AvantGuard - DNSFilter

Actions277

Overview

This node operation, Traffic Reports Total Category Stats, retrieves aggregated traffic report statistics filtered by various optional parameters such as category IDs, network IDs, time range, and organizational identifiers. It is useful for users who want to analyze total traffic data categorized by specific criteria over a defined period.

Typical use cases include:

  • Generating summary reports of network traffic by categories for a given organization or MSP.
  • Filtering traffic data within a custom date/time range.
  • Restricting reports to specific networks or categories to focus on relevant segments.

For example, a network administrator could use this node to fetch total traffic stats for certain categories across selected networks during the last week to monitor usage patterns.

Properties

Name Meaning
Additional Query Parameters Optional fields to refine the traffic report query:
- Category Ids Comma separated list of category IDs to filter by; defaults to all categories if empty
- From UTC lower limit for the report in YYYY-MM-DDThh:mm:ss or YYYY-MM-DDThh:mm:ssZ format; defaults to current UTC minus 1 day if invalid or empty
- Msp Id Managed Service Provider ID to filter the report
- Network Ids Comma separated list of network IDs to filter by; defaults to all networks if empty
- Organization Id Organization ID to filter the report; defaults to the user's organization ID if zero or empty
- To UTC upper limit for the report in YYYY-MM-DDThh:mm:ss or YYYY-MM-DDThh:mm:ssZ format; defaults to current UTC if invalid or empty

Output

The node outputs JSON data containing the total category statistics for the requested traffic reports. The structure typically includes aggregated metrics grouped by category, such as counts or sums of traffic events, filtered according to the input parameters.

No binary data output is indicated for this operation.

Dependencies

  • Requires an API key credential for authenticating with the external traffic reporting service.
  • The node uses HTTP requests to communicate with the service's REST API endpoint.
  • Proper configuration of the API base URL and authentication headers is necessary.

Troubleshooting

  • Invalid Date Format: If the From or To parameters are not in the expected ISO 8601 format, the node defaults to preset values (current UTC or current UTC minus one day). Ensure correct formatting to get precise results.
  • Empty or Incorrect IDs: Providing invalid or non-existent category, network, MSP, or organization IDs may result in empty responses or errors. Verify IDs before use.
  • Authentication Errors: Missing or incorrect API credentials will cause authentication failures. Confirm that the API key credential is correctly set up.
  • API Rate Limits or Downtime: External service limitations can cause request failures. Check service status and retry policies.

Links and References

  • Refer to the external traffic reporting service API documentation for detailed parameter descriptions and response formats.
  • Use standard ISO 8601 date-time format references for specifying From and To parameters.

Discussion