Foreplay API icon

Foreplay API

Interact with the Foreplay API

Overview

This node interacts with the Foreplay API to perform various operations related to advertising data. Specifically, for the "Get Spyder Brand" operation, it retrieves information about a particular brand identified as a "Spyder Brand" from the Foreplay platform. This can be useful for marketing analysts or advertisers who want to gather detailed brand data for competitive analysis, campaign planning, or market research.

Practical examples include:

  • Fetching a list of top Spyder Brands to analyze their advertising strategies.
  • Integrating brand data into dashboards for monitoring brand performance.
  • Automating reports that track changes in brand presence over time.

Properties

Name Meaning
Limit Max number of results to return. Specifies how many Spyder Brand records to retrieve. Default is 5.

Output

The node outputs an array of JSON objects under the json field. Each object corresponds to a response from the Foreplay API for the requested operation. For the "Get Spyder Brand" operation, each item in the output array contains details about one or more Spyder Brands as returned by the API.

If the API supports binary data (not indicated here), it would typically represent media or files associated with brands, but this node primarily returns JSON data.

Dependencies

  • Requires an API key credential for authenticating with the Foreplay API.
  • The base URL for the API must be configured in the credentials.
  • Uses HTTP requests with authentication handled internally by n8n's helper methods.

Troubleshooting

  • Invalid operation error: If the operation name is incorrect or not supported, the node throws an "Invalid operation" error. Ensure the operation parameter is set exactly to "getSpyderBrand" for this use case.
  • API connection issues: Errors related to network or authentication failures may occur if the API key or base URL is misconfigured. Verify credentials and connectivity.
  • Empty results: If no Spyder Brands are returned, check the "Limit" property and ensure the API has relevant data available.
  • Continue on Fail: If enabled, the node will continue processing subsequent items even if some fail, returning error messages in the output.

Links and References

Discussion