Actions6
- 🏭 Partner Actions
- 🏣 Company Actions
Overview
This node integrates with the AvantGuard Phin Security API to retrieve various company reports. Specifically, for the "Get Company Report" operation under the "🏣 Company" resource, it fetches detailed reports such as performance summaries, phishing incident data, training records, and user watchlists in PDF or CSV formats.
Common scenarios where this node is beneficial include:
- Security teams automating the retrieval of periodic security performance reports.
- Compliance officers gathering phishing and training data for audits.
- Analysts monitoring users flagged for suspicious activity via watchlists.
Practical example: Automatically download the monthly phishing report PDF for a specific company and partner, then use it in further workflow steps like sending emails or archiving.
Properties
| Name | Meaning |
|---|---|
| Partner Id | Identifier for the partner organization associated with the company. |
| Company Id | Identifier for the target company whose report is being requested. |
| Report Path | The type of report file to retrieve. Options include: - Performance Report Pdf - Phishing Report Pdf - Phishing Click Csv - Training Data Csv - Users To Watch Csv |
| Additional Query Parameters | Optional parameters to refine the report request: - Type: Frequency of the report (Monthly or Weekly) - Year: Numeric year (e.g., 2025) - Month: Numeric month (1-12) - Day: Numeric day (1-31) |
Output
The node outputs the retrieved report data in the json field of the output item. The content corresponds to the selected report type:
- For PDF reports (Performance Report, Phishing Report), the output will typically be base64-encoded binary data representing the PDF file.
- For CSV reports (Phishing Click, Training Data, Users To Watch), the output contains CSV data as text.
If the node supports binary data output, the binary property will hold the actual file content suitable for saving or further processing.
Dependencies
- Requires an active connection to the AvantGuard Phin Security API.
- Needs an API authentication token configured in n8n credentials to authorize requests.
- Network access to
https://api.phinsec.iomust be available from the n8n instance.
Troubleshooting
- Missing or invalid API credentials: The node will fail if the API key is not set or incorrect. Ensure the API token credential is properly configured.
- Invalid Partner Id or Company Id: Errors may occur if these identifiers do not exist or are mistyped. Verify correctness before running.
- Unsupported report path: Selecting a report path not supported by the API will cause errors. Use only the provided options.
- Incorrect date parameters: Providing invalid year, month, or day values can lead to failed requests. Confirm that numeric inputs are within valid ranges.
- Network issues: Connectivity problems to the API endpoint will result in timeouts or connection errors.
Links and References
- AvantGuard Phin Security API Documentation (hypothetical link)
- n8n documentation on Using API Credentials