brand_idsarrayrequired
Brand ID(s) to search for. Can be a single ID or multiple IDs separated by commas.
Foreplay Brand Ads
https://api.sandbase.ai/v1/api/foreplay/brand-adsList the social ads a brand has run by Foreplay brand ID, with creative, copy, platforms, run dates and landing page, filtered by format, platform and run time.
- Price
- From $0.0525USD / call
- Method
- POST
- Response
- JSON
- Parameters
- 1 required · 16 optional
Playground
Input
Brand ID(s) to search for. Can be a single ID or multiple IDs separated by commas.
Number of results (1-20). Each returned item is billed at about $0.0175, so this caps the cost of one call. Maximum: 20.
Best-effort live fallback. If the cached results are empty and `collect=true`, the API translates each brand id to its Meta page id (`adlibraryid`), kicks off a live fetch through our Spyder pipeline, and polls for ~30 seconds. Returns whatever is available at the end of the window — may still be empty if a brand has no Meta page on file, the page is restricted, deleted, or simply isn't running ads. Not perfect — use it as a fallback when the regular response is empty, not as a default.
Cursor for pagination. Use the cursor value from the previous response's metadata to get the next page of results.
Filter by one or more display formats. Available formats (11): carousel, dco, dpa, event, image, multi_images, multi_medias, multi_videos, page_like, text, video Example: `?display_format=video&display_format=carousel`
End date (inclusive). Format: 'YYYY-MM-DD', 'YYYY-MM-DDTHH:MM:SS', or 'YYYY-MM-DD HH:MM:SS'. If you provide only the date (e.g. '2024-11-12'), it will be interpreted as '2024-11-12 00:00:00'. To include all results for a given day, set end_date to 'YYYY-MM-DD 23:59:59' or to the next day at '00:00:00'. Examples: start_date=2024-11-12 00:00:00, end_date=2024-11-12 23:59:59.
Filter by languages. Accepts various language formats: 'french', 'FR', 'romanian', 'ro', 'english', 'en', etc. Example: `?languages=en&languages=fr`
Filter ads by live status. `true` means currently active ads, `false` means inactive ads. Leave empty to include both.
Filter by market target. Available targets: b2b (business-to-business), b2c (business-to-consumer) Example: `?market_target=b2b`
Filter by one or more niches. Available niches: travel, food, fashion, beauty, health, technology, automotive, finance, education, entertainment, sports, home, pets, business, other Example: `?niches=travel&niches=fashion`
Order of results: 'newest' (default), 'oldest', 'longest_running', or 'most_relevant'. Sorts ads by creation date, longest running duration, or relevance to the search query.
Filter by one or more publisher platforms. Available platforms: facebook, instagram, audience_network, messenger, tiktok, youtube, linkedin, threads, whatsapp Example: `?publisher_platform=facebook&publisher_platform=instagram`
Filter ads by maximum running duration in days. Must be a positive integer.
Filter ads by minimum running duration in days. Must be a positive integer.
Start date (inclusive). Format: 'YYYY-MM-DD', 'YYYY-MM-DDTHH:MM:SS', or 'YYYY-MM-DD HH:MM:SS'. If you provide only the date (e.g. '2024-11-12'), it will be interpreted as '2024-11-12 00:00:00'. To get all ads from a specific day, set end_date to 'YYYY-MM-DD 23:59:59' or to the next day at '00:00:00'. Examples: start_date=2024-11-12 00:00:00, end_date=2024-11-12 23:59:59.
Filter ads by maximum video duration in seconds. Only applies to video ads.
Filter ads by minimum video duration in seconds. Only applies to video ads.
OutputReady
Your output will appear here
Complete the inputs, then click Run.
API README
Foreplay Brand Ads
List the social ads a brand has run by Foreplay brand ID, with creative, copy, platforms, run dates and landing page, filtered by format, platform and run time.
Request
curl -X POST "https://api.sandbase.ai/v1/api/foreplay/brand-ads" \
-H "Authorization: Bearer $SANDBASE_API_KEY" \
-H "Content-Type: application/json" \
-d '{"brand_ids": ["3YfFtyvZ3viTAbbLaWLV"], "limit": 3}'
The result is returned in outputs[0].data.
Parameters
| Name | Type | Required | Description |
|---|---|---|---|
brand_ids | array | Yes | Brand ID(s) to search for. Can be a single ID or multiple IDs separated by commas. |
limit | integer | No | Pagination limit (max 250). Controls the number of ads returned per request. |
collect | string | No | Best-effort live fallback. If the cached results are empty and collect=true, the API translates each brand id to its Meta page id (adlibraryid), kicks off a live fetch through our Spyder pipeline, and polls for ~30 s |
cursor | string | No | Cursor for pagination. Use the cursor value from the previous response's metadata to get the next page of results. |
display_format | string | No | Filter by one or more display formats. Available formats (11): carousel, dco, dpa, event, image, multi_images, multi_medias, multi_videos, page_like, text, video Example: ?display_format=video&display_format=carousel |
end_date | string | No | End date (inclusive). Format: 'YYYY-MM-DD', 'YYYY-MM-DDTHH:MM:SS', or 'YYYY-MM-DD HH:MM:SS'. If you provide only the date (e.g. '2024-11-12'), it will be interpreted as '2024-11-12 00:00:00'. To include all results for a |
languages | string | No | Filter by languages. Accepts various language formats: 'french', 'FR', 'romanian', 'ro', 'english', 'en', etc. Example: ?languages=en&languages=fr |
live | string | No | Filter ads by live status. true means currently active ads, false means inactive ads. Leave empty to include both. |
market_target | string | No | Filter by market target. Available targets: b2b (business-to-business), b2c (business-to-consumer) Example: ?market_target=b2b |
niches | string | No | Filter by one or more niches. Available niches: travel, food, fashion, beauty, health, technology, automotive, finance, education, entertainment, sports, home, pets, business, other Example: `?niches=travel&niches=fashio |
order | string | No | Order of results: 'newest' (default), 'oldest', 'longest_running', or 'most_relevant'. Sorts ads by creation date, longest running duration, or relevance to the search query. |
publisher_platform | string | No | Filter by one or more publisher platforms. Available platforms: facebook, instagram, audience_network, messenger, tiktok, youtube, linkedin, threads, whatsapp Example: `?publisher_platform=facebook&publisher_platform=ins |
running_duration_max_days | string | No | Filter ads by maximum running duration in days. Must be a positive integer. |
running_duration_min_days | string | No | Filter ads by minimum running duration in days. Must be a positive integer. |
start_date | string | No | Start date (inclusive). Format: 'YYYY-MM-DD', 'YYYY-MM-DDTHH:MM:SS', or 'YYYY-MM-DD HH:MM:SS'. If you provide only the date (e.g. '2024-11-12'), it will be interpreted as '2024-11-12 00:00:00'. To get all ads from a spec |
video_duration_max | string | No | Filter ads by maximum video duration in seconds. Only applies to video ads. |
video_duration_min | string | No | Filter ads by minimum video duration in seconds. Only applies to video ads. |
Pricing
Billed at the actual upstream cost of each call (about $0.0525 for the request above). Failed calls are not charged.
Start building
Send your first request
Platform API endpoint with unified authentication and usage tracking.
# The quoted heredoc keeps Unicode and shell metacharacters unchanged.
result=$(curl --fail-with-body --silent \
-X POST "https://api.sandbase.ai/v1/api/foreplay/brand-ads" \
-H "Authorization: Bearer $SANDBASE_API_KEY" \
-H "Content-Type: application/json" \
--data-binary @- <<'SANDBASE_JSON'
{
"limit": 3,
"order": "newest",
"collect": "false",
"brand_ids": [
"3YfFtyvZ3viTAbbLaWLV"
]
}
SANDBASE_JSON
)
printf '%s\n' "$result"2. Authentication
Set your SandBase API key in your server environment. Requests use Bearer authentication.
export SANDBASE_API_KEY="YOUR_API_KEY"Keep your key on the server. Do not expose it in browser code.
3. Parameters
limitinteger
Number of results (1-20). Each returned item is billed at about $0.0175, so this caps the cost of one call.
Default: 10
collectstring
Best-effort live fallback. If the cached results are empty and `collect=true`, the API translates each brand id to its Meta page id (`adlibraryid`), kicks off a live fetch through our Spyder pipeline, and polls for ~30 seconds. Returns whatever is available at the end of the window — may still be empty if a brand has no Meta page on file, the page is restricted, deleted, or simply isn't running ads. Not perfect — use it as a fallback when the regular response is empty, not as a default.
Default: "false"
cursorstring
Cursor for pagination. Use the cursor value from the previous response's metadata to get the next page of results.
display_formatstring
Filter by one or more display formats. Available formats (11): carousel, dco, dpa, event, image, multi_images, multi_medias, multi_videos, page_like, text, video Example: `?display_format=video&display_format=carousel`
Possible values: carousel, dco, dpa, event, image, multi_images, multi_medias, multi_videos, page_like, text, video
end_datestring
End date (inclusive). Format: 'YYYY-MM-DD', 'YYYY-MM-DDTHH:MM:SS', or 'YYYY-MM-DD HH:MM:SS'. If you provide only the date (e.g. '2024-11-12'), it will be interpreted as '2024-11-12 00:00:00'. To include all results for a given day, set end_date to 'YYYY-MM-DD 23:59:59' or to the next day at '00:00:00'. Examples: start_date=2024-11-12 00:00:00, end_date=2024-11-12 23:59:59.
languagesstring
Filter by languages. Accepts various language formats: 'french', 'FR', 'romanian', 'ro', 'english', 'en', etc. Example: `?languages=en&languages=fr`
livestring
Filter ads by live status. `true` means currently active ads, `false` means inactive ads. Leave empty to include both.
market_targetstring
Filter by market target. Available targets: b2b (business-to-business), b2c (business-to-consumer) Example: `?market_target=b2b`
nichesstring
Filter by one or more niches. Available niches: travel, food, fashion, beauty, health, technology, automotive, finance, education, entertainment, sports, home, pets, business, other Example: `?niches=travel&niches=fashion`
orderstring
Order of results: 'newest' (default), 'oldest', 'longest_running', or 'most_relevant'. Sorts ads by creation date, longest running duration, or relevance to the search query.
Default: "newest"
Possible values: newest, oldest, longest_running, most_relevant
publisher_platformstring
Filter by one or more publisher platforms. Available platforms: facebook, instagram, audience_network, messenger, tiktok, youtube, linkedin, threads, whatsapp Example: `?publisher_platform=facebook&publisher_platform=instagram`
Possible values: facebook, instagram, audience_network, messenger, tiktok, youtube, linkedin, threads, whatsapp
running_duration_max_daysstring
Filter ads by maximum running duration in days. Must be a positive integer.
running_duration_min_daysstring
Filter ads by minimum running duration in days. Must be a positive integer.
start_datestring
Start date (inclusive). Format: 'YYYY-MM-DD', 'YYYY-MM-DDTHH:MM:SS', or 'YYYY-MM-DD HH:MM:SS'. If you provide only the date (e.g. '2024-11-12'), it will be interpreted as '2024-11-12 00:00:00'. To get all ads from a specific day, set end_date to 'YYYY-MM-DD 23:59:59' or to the next day at '00:00:00'. Examples: start_date=2024-11-12 00:00:00, end_date=2024-11-12 23:59:59.
video_duration_maxstring
Filter ads by maximum video duration in seconds. Only applies to video ads.
video_duration_minstring
Filter ads by minimum video duration in seconds. Only applies to video ads.
4. Response
Saved example response for this API; no live request is made when viewing it.
No saved response has been published. Run the API in Playground to inspect its response.
Explore more
Related APIs
| API | Price | Response |
|---|---|---|
Foreplay Brand AdsThis API Foreplay | From $0.0525 per call | JSON |
Foreplay | From $0.0525 per call | JSON |
Foreplay | From $0.1225 per call | JSON |
Foreplay | From $0.0175 per call | JSON |
Questions
FAQ
How do I use the Foreplay Brand Ads API?
Send a POST request to https://api.sandbase.ai/v1/api/foreplay/brand-ads with your SandBase API key in the Authorization header (Bearer) and the parameters as a JSON body. You can also try it in the Playground on this page without writing code.
How much does the Foreplay Brand Ads API cost?
From $0.0525 per call, billed from your SandBase balance. You are only charged for calls you make; there is no subscription.
What parameters does the Foreplay Brand Ads API accept?
Required: brand_ids (array). Optional: limit (integer), collect (string), cursor (string), display_format (one of carousel, dco, dpa, event, image, multi_images, multi_medias, multi_videos, page_like, text, video), end_date (string) and languages (string) and 10 more. The Parameters table and the Playground on this page list every field.
What does the Foreplay Brand Ads API return?
A JSON response returned in the same HTTP request (synchronous).
Do I need a Foreplay developer account or API key?
No. Foreplay Brand Ads runs through SandBase, so one SandBase API key covers this endpoint and every other API and model in the catalog. You do not need to apply for Foreplay API access separately.