AvantGuard - DNSFilter icon

AvantGuard - DNSFilter

AvantGuard - DNSFilter

Actions277

Overview

This node operation fetches usage reports by organization for distributors on a specified date. It is useful for users who want to analyze or monitor how different organizations under distributors are utilizing services or products on a particular day. For example, a distributor manager could use this node to generate daily usage statistics across multiple organizations to track engagement or compliance.

Properties

Name Meaning
Date The report date in ISO8601 format (e.g., 2022-12-31). This specifies the day for which usage data is retrieved.
Additional Query Parameters Optional parameters to refine the report:
- Include In Trial: Whether to include organizations currently in trial (true/false).
- Include Parent Organization: Whether to include MSPs parent organizations (true/false).
- Msp Ids: JSON array of MSP IDs to filter the report (e.g., [1,2,3]).
- Organization Ids: JSON array of organization IDs to filter the report (e.g., [4,5,6]).

Output

The node outputs JSON data containing the usage report for organizations under distributors for the specified date and query parameters. The structure typically includes details per organization such as usage metrics, identifiers, and possibly metadata about trial status or parent organizations if those options are enabled. No binary data output is indicated.

Dependencies

  • Requires an API key credential for authenticating requests to the external service.
  • The node uses a base URL https://api.dnsfilter.com indicating it connects to an external API endpoint.
  • Proper configuration of authentication credentials within n8n is necessary for successful execution.

Troubleshooting

  • Missing or invalid date: Since the date property is required, omitting it or providing an incorrectly formatted date will likely cause errors. Ensure the date is in ISO8601 format.
  • Invalid JSON in MSP or Organization IDs: The MSP and Organization IDs must be valid JSON arrays. Malformed JSON will cause request failures.
  • API authentication errors: If the API key credential is missing or incorrect, the node will fail to authenticate with the external service.
  • Network or API downtime: Connectivity issues or service outages at the external API endpoint may result in timeouts or error responses.
  • To resolve these, verify input formats, ensure credentials are correctly set up, and check network connectivity.

Links and References

  • ISO 8601 Date Format
  • External API documentation (not provided here) would be needed for detailed field descriptions in the output.

Discussion