Foreplay API icon

Foreplay API

Interact with the Foreplay API

Actions13

Overview

This node integrates with the Foreplay API to retrieve detailed information about ads. Specifically, the "Get Ad Details" operation fetches comprehensive data for a single ad identified by its unique Ad ID. This is useful in scenarios where users want to analyze or display specific ad content, metadata, or performance details from the Foreplay platform.

Practical examples include:

  • Fetching detailed ad information for reporting or analytics dashboards.
  • Retrieving ad content to display within marketing tools or CMS.
  • Auditing or monitoring specific ads by their IDs.

Properties

Name Meaning
Ad ID The unique identifier of the ad to get details for. This is required for the operation.
Cursor A pagination cursor to navigate through paged results (if applicable).
Limit Maximum number of results to return; defaults to 5.
Order The order in which results are returned. Options: Newest, Oldest, Longest Running, Most Relevant.

Note: For the "Get Ad Details" operation, only "Ad ID" is strictly required. Other properties like Cursor, Limit, and Order can influence result handling if supported by the API endpoint.

Output

The node outputs an array of JSON objects under the json field. Each object contains the response from the Foreplay API corresponding to the requested ad details. The structure depends on the API's response but typically includes fields such as ad metadata, content, timestamps, and possibly performance metrics.

No binary data output is indicated by the source code.

Example output snippet (conceptual):

[
  {
    "response": {
      "id": "12345",
      "title": "Sample Ad Title",
      "content": "...",
      "created_at": "2024-01-01T12:00:00Z",
      "metrics": {
        "impressions": 1000,
        "clicks": 50
      }
      // other ad-specific fields
    }
  }
]

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 helpers.
  • No additional external dependencies beyond the Foreplay API service.

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 "getAdDetails".
  • Missing or invalid Ad ID: Since Ad ID is required, omitting it or providing an invalid ID will likely cause API errors or empty responses.
  • API connectivity issues: Network problems or incorrect API credentials can cause request failures. Verify API keys and base URL configuration.
  • Pagination parameters ignored: For this operation, pagination parameters like Cursor and Limit may not have effect if the API endpoint does not support them for single ad retrieval.

Links and References

Discussion