AvantGuard - ConnectSecure icon

AvantGuard - ConnectSecure

AvantGuard - ConnectSecure

Actions223

Overview

This node integrates with the AvantGuard ConnectSecure API to retrieve statistical data about companies. Specifically, the "Get Retrieve Company Stats" operation fetches company statistics based on user identification and optional query parameters. This node is useful in scenarios where you need to analyze or report on company-related metrics, such as monitoring performance indicators, generating summaries for dashboards, or filtering company stats based on specific conditions.

Practical examples include:

  • Fetching company stats for a particular user to display personalized analytics.
  • Retrieving a limited set of company stats ordered by a certain field for reporting purposes.
  • Skipping a number of records to paginate through large datasets of company statistics.

Properties

Name Meaning
X USER ID The User Id required to identify the user whose company stats are being retrieved.
Additional Query Parameters Optional parameters to refine the query:
- Condition: Filter condition for the query.
- Skip: Number of records to skip (for pagination).
- Limit: Maximum number of records to return.
- Order By: Field name to order the results by.

Output

The node outputs JSON data containing the retrieved company statistics. The structure of the json output field corresponds to the response from the AvantGuard ConnectSecure API's company stats endpoint. It typically includes statistical fields relevant to companies filtered or queried according to the input parameters.

No binary data output is indicated by the source code or properties.

Dependencies

  • Requires an API key credential for authenticating with the AvantGuard ConnectSecure API.
  • The base URL for the API must be configured in the node credentials.
  • The node depends on the @avantguardllc/n8n-openapi-node package and an OpenAPI specification (openapi.json) bundled within the node for request building.

Troubleshooting

  • Missing or invalid X USER ID: Since the user ID is required, omitting it or providing an incorrect value will likely cause authentication or data retrieval errors. Ensure the user ID is correctly provided.
  • Invalid query parameters: Providing unsupported or malformed query parameters (e.g., non-numeric values for skip or limit) may result in API errors. Validate inputs before execution.
  • API connectivity issues: Network problems or incorrect base URL configuration can prevent successful API calls. Verify network access and credential settings.
  • Permission errors: If the API key lacks permissions to access company stats, the node will fail. Confirm that the API key has appropriate rights.

Links and References

Discussion