AvantGuard - DNSFilter icon

AvantGuard - DNSFilter

AvantGuard - DNSFilter
Join our community

Actions277

Overview

This node operation, Distributors Organizations Index, retrieves a list of organizations associated with distributors. It allows filtering and querying organizations based on various criteria such as creation date, cancellation status, distributor IDs, names, and other metadata. This is useful for scenarios where you need to programmatically access and analyze distributor-related organizational data, for example:

  • Generating reports on active or canceled organizations within specific time frames.
  • Filtering organizations by distributor SKU or status for inventory or sales analysis.
  • Fetching organizations managed by a particular MSP (Managed Service Provider).
  • Paginating through large sets of organization data for batch processing.

Properties

Name Meaning
Additional Query Parameters Optional filters and query parameters to refine the search results. These include:
- Canceled At From/To: Unix timestamp range for cancellation date (requires canceled filter).
- Created At From/To: Unix timestamp range for creation date.
- Distributor Id: Case-insensitive pattern to filter by distributor ID.
- Distributor Sku: Case-sensitive exact match for distributor SKU.
- Distributor Status: Case-sensitive exact match for distributor status.
- External Id: Case-insensitive pattern for external ID.
- Include Canceled: Boolean to include canceled organizations.
- Msp Id: Exact match filter for MSP ID; excludes MSP parent org.
- Name: Case-insensitive pattern for organization name.
- Only Canceled: Boolean to filter only canceled organizations.
- Page: JSON object specifying page number and size (max 1500).
- Transferred At From/To: Unix timestamp range for transfer date.
- Trial End: Exact match date in ISO8601 format.
- Updated At From/To: Unix timestamp range for last update date.

Output

The node outputs JSON data representing the list of organizations matching the specified filters. Each item in the output array corresponds to an organization with its associated properties as returned by the API. The structure typically includes identifiers, timestamps, status fields, and other metadata relevant to each organization.

If binary data were involved, it would be summarized here, but this operation deals solely with JSON data.

Dependencies

  • Requires an API key credential for authenticating requests to the distributor service's REST API.
  • The base URL for API requests is preset to the distributor service endpoint.
  • No additional environment variables are explicitly required beyond the API authentication token.

Troubleshooting

  • Empty Results: If no organizations are returned, verify that your query parameters are correct and that the filters are not overly restrictive.
  • Authentication Errors: Ensure the API key credential is valid and has sufficient permissions.
  • Pagination Issues: When dealing with large datasets, ensure the page parameter is correctly formatted and respects the maximum page size limit (1500).
  • Timestamp Filters Not Working: For cancellation date filters (canceled_at_from, canceled_at_to), either include_canceled or only_canceled must be set to true for these filters to apply.
  • Invalid Date Formats: For the trial_end property, ensure the date is in ISO8601 format (e.g., "2022-12-31").

Links and References

  • Refer to the distributor service API documentation for detailed descriptions of query parameters and response schema.
  • Use standard Unix timestamp converters to generate appropriate filter values.
  • ISO8601 date format reference: https://en.wikipedia.org/wiki/ISO_8601

Discussion