AvantGuard - ConnectSecure icon

AvantGuard - ConnectSecure

AvantGuard - ConnectSecure

Actions223

Overview

This node allows users to create reports by sending a POST request to an external API endpoint. It is designed for scenarios where automated report generation is needed, such as generating business analytics, compliance reports, or custom data summaries. Users can specify various report parameters and filters to tailor the report output.

Practical examples include:

  • Creating a sales report filtered by date range and product category.
  • Generating a compliance report for a specific company.
  • Automating report creation with dynamic user IDs and report types.

Properties

Name Meaning
X USER ID The user identifier required for authentication or tracking purposes in the request header.
Additional Body Fields Optional fields to customize the report creation request body. Includes:
- Company Id Numeric identifier of the company for which the report is generated.
- Company Name Name of the company related to the report.
- Report Id Identifier for the specific report.
- Report Name Name/title of the report.
- Report Type Type/category of the report (e.g., summary, detailed).
- File Type Desired file format of the report output (e.g., PDF, CSV).
- Is Filter Boolean flag indicating whether to apply filters to the report.
- Report Filter JSON object defining filter criteria for the report content.

Output

The node outputs JSON data representing the response from the report creation API. This typically includes details about the created report such as its ID, status, and any metadata returned by the service.

If the API supports binary data (e.g., the actual report file), the node would handle it accordingly, but based on the provided code and properties, the primary output is JSON structured data.

Dependencies

  • Requires an API key credential for authenticating requests to the external report service.
  • The base URL for the API must be configured in the node credentials.
  • Uses HTTP headers including a mandatory user ID header (X-USER-ID).
  • Relies on the external API defined in the bundled OpenAPI specification (openapi.json).

Troubleshooting

  • Missing or invalid X USER ID header: The API may reject requests without this header or with incorrect values. Ensure the user ID is correctly set.
  • Invalid or incomplete additional body fields: Providing wrong data types or missing required fields in the optional collection may cause API errors.
  • API authentication failures: Verify that the API key credential is valid and has necessary permissions.
  • Malformed JSON in Report Filter: Since this field expects JSON, ensure it is properly formatted; otherwise, parsing errors may occur.
  • Network or connectivity issues: Confirm that the base URL is reachable and no firewall or proxy blocks the request.

Links and References

  • Refer to the external API documentation for detailed information on report creation endpoints and supported parameters.
  • n8n documentation on how to configure API credentials and use HTTP headers in nodes.
  • JSON formatting guides for constructing valid filter objects.

Discussion