SOCRadar icon

SOCRadar

Comprehensive SOCRadar API integration
Join our community

Actions21

Overview

The "Get Brand Protection" operation in this node retrieves various types of brand protection data related to a specified company. It is designed to help organizations monitor and protect their brand reputation by fetching information about impersonating accounts, impersonating domains, rogue mobile applications, bad reputation incidents, and social media findings.

Common scenarios where this node is beneficial include:

  • Monitoring for fraudulent or impersonating online entities that could harm the company's brand.
  • Detecting rogue mobile apps that misuse the company's identity.
  • Tracking negative reputation signals or social media mentions that may require action.
  • Filtering and analyzing brand protection data over specific time frames or regions.

For example, a security team might use this node to regularly check for new impersonating social media accounts or suspicious domains mimicking their brand, enabling timely mitigation.

Properties

Name Meaning
Company ID The unique identifier of the company for which brand protection data is requested.
Operation Type The type of brand protection data to retrieve. Options: Impersonating Accounts, Impersonating Domains, Rogue Mobile Applications, Bad Reputation, Social Media Findings.
Additional Fields Optional filters and parameters to refine the data retrieval:
- Search String Text string to filter results by matching content.
- Record Status Filter results by their record status.
- Record Status Reason Filter results by the reason for their record status.
- Alarm Status Filter results based on alarm status.
- Country Code Filter results by country code (e.g., "US", "GB").
- Include Historical Boolean flag to include historical data in the results.
- Start Date Start date to filter records from (format expected as string).
- End Date End date to filter records until (format expected as string).
- Page Pagination page number to retrieve.
- Limit Number of results per page.
- Order Direction Direction to order results (e.g., ascending or descending).

Output

The output is an array of JSON objects representing the retrieved brand protection data according to the selected operation type and applied filters. Each item corresponds to a record such as an impersonating account, domain, rogue app, reputation incident, or social media finding.

The exact structure of each JSON object depends on the operation type but generally includes details relevant to the brand protection issue detected.

This node does not output binary data.

Dependencies

  • Requires an API key credential for authenticating with the SOCRadar API service.
  • The node expects the base URL and API key to be configured via credentials.
  • No other external dependencies are indicated.

Troubleshooting

  • Common issues:

    • Invalid or missing API key credential will cause authentication failures.
    • Incorrect or missing Company ID will result in errors or empty responses.
    • Using unsupported or malformed filter values in additional fields may lead to API errors.
    • Pagination parameters exceeding available pages may return empty results.

  • Error messages:

    • Errors returned from the API are captured and included in the output under an error field with optional details.
    • Common error messages relate to authorization failures, invalid parameters, or rate limiting.

  • Resolution tips:

    • Verify that the API key credential is correctly set up and has necessary permissions.
    • Double-check the Company ID and filter parameters for correctness.
    • Use pagination parameters within valid ranges.
    • Enable "Continue On Fail" option in n8n to handle errors gracefully during batch processing.

Links and References

Discussion