Foreplay API icon

Foreplay API

Interact with the Foreplay API

Overview

This node integrates with the Foreplay API to retrieve brand information based on a given domain name. It is particularly useful for marketing professionals, brand analysts, or developers who want to gather brand data associated with specific websites or domains. For example, you can input a domain like "example.com" or a full URL such as "https://example.com" and get back a list of brands related to that domain.

Properties

Name Meaning
Domain The domain name to search for brands. Can be a full URL (e.g., "https://example.com") or just the domain (e.g., "example.com"). This is a required field.
Limit Maximum number of brand results to return. Defaults to 5. Must be at least 1.

Output

The node outputs an array of JSON objects under the json output field. Each object contains the response from the Foreplay API for the "Get Brands by Domain" operation. The exact structure depends on the API's response but generally includes brand details related to the specified domain.

No binary data is output by this node.

Dependencies

  • Requires an API key credential for the Foreplay API.
  • The base URL for the API must be configured in the node credentials.
  • The node uses HTTP requests with authentication to communicate with the Foreplay API.

Troubleshooting

  • Invalid operation error: If the operation parameter is incorrect or missing, the node will throw an "Invalid operation" error. Ensure the operation is set to "Get Brands by Domain".
  • API connection issues: Errors may occur if the API key is invalid or the base URL is misconfigured. Verify your credentials and endpoint settings.
  • Empty or no results: If the domain does not correspond to any brands, the returned array may be empty. Double-check the domain format and try again.
  • Limit value errors: Setting the limit below 1 may cause validation errors. Use a positive integer equal to or greater than 1.

Links and References

  • Foreplay API Documentation (replace with actual URL)
  • n8n HTTP Request Node documentation for understanding request options and authentication.

Discussion