AvantGuard - DNSFilter icon

AvantGuard - DNSFilter

AvantGuard - DNSFilter

Actions277

Overview

This node operation retrieves detailed usage metrics for a specific organization within a given date range. It is useful for analyzing how an organization's resources or services are being utilized over time, enabling administrators or analysts to monitor activity, track trends, and generate reports based on usage data.

Practical examples include:

  • Monitoring API call volumes or service consumption by an organization.
  • Generating detailed usage reports for billing or auditing purposes.
  • Tracking changes in usage patterns between two dates to identify growth or anomalies.

Properties

Name Meaning
From The start date of the period for which to retrieve usage data. Must be in ISO8601 format (e.g., "2023-12-01").
Id The unique identifier of the organization whose usage metrics are being requested.
To The end date of the period for which to retrieve usage data. Must be in ISO8601 format (e.g., "2023-12-01").

Output

The output JSON contains detailed usage metrics for the specified organization between the given dates. This typically includes structured data such as timestamps, usage counts, resource identifiers, or other relevant statistics depending on the external API's response.

If the node supports binary data output, it would represent downloadable reports or files related to the usage metrics, but this is not indicated in the provided code or properties.

Dependencies

  • Requires an API key credential for authenticating requests to the external metrics service.
  • The node sends HTTP requests with query parameters from and to for date filtering, and id for specifying the organization.
  • Proper configuration of the API base URL and authentication headers is necessary.

Troubleshooting

  • Invalid Date Format: Ensure that the From and To dates are in valid ISO8601 format (e.g., "YYYY-MM-DD"). Incorrect formats may cause request failures.
  • Missing or Incorrect Organization ID: Providing an invalid or non-existent organization ID will result in errors or empty responses.
  • Authentication Errors: Verify that the API key credential is correctly configured and has sufficient permissions.
  • Date Range Issues: The From date should not be after the To date; otherwise, the API might return errors or no data.
  • Network or API Downtime: Temporary connectivity issues or service outages can cause request failures.

Links and References

  • Refer to the external metrics service API documentation for detailed information on the usage metrics endpoint and data schema.
  • ISO8601 date format specification: https://en.wikipedia.org/wiki/ISO_8601

Discussion