Foreplay API icon

Foreplay API

Interact with the Foreplay API

Actions13

Overview

This node interacts with the Foreplay API to perform various operations related to advertising data. Specifically, for the "Get Tracked Brands" operation, it retrieves a list of brands that are being tracked by the user or system. This can be useful for marketers or analysts who want to monitor competitor brands or track brand performance over time.

Practical examples include:

  • Fetching a limited number of tracked brands to display in a dashboard.
  • Integrating tracked brand data into reporting workflows.
  • Automating alerts or actions based on changes in tracked brand information.

Properties

Name Meaning
Limit Max number of results to return (minimum 1). Controls how many tracked brands are fetched in one execution.

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 "Get Tracked Brands," each item in the output array contains details about a tracked brand as returned by the API.

No binary data is output by this node.

Example structure of one output item might look like:

{
  "response": {
    "brands": [
      {
        "id": "brand_id_123",
        "name": "Brand Name",
        "trackingStatus": "active",
        ...
      },
      ...
    ]
  }
}

Dependencies

  • Requires an API key credential for 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 credential system.

Troubleshooting

  • Invalid operation error: If the operation name is incorrect or not supported, the node will throw an "Invalid operation" error. Ensure the operation parameter is set exactly to "getTrackedBrands".
  • API connection issues: Errors related to network connectivity or invalid credentials may occur. Verify the API key and base URL are correctly configured.
  • Empty results: If no tracked brands are returned, check if the account actually has tracked brands or adjust the "Limit" property.
  • Continue on Fail: If enabled, the node will continue processing subsequent items even if one fails, returning error messages in the output.

Links and References

Discussion