API reference · Facebook
facebook/company-ads
Integrate this model through SandBase's unified API, with production-ready schemas and examples.
Production endpoint
Send your first request
OpenAI-compatible endpoint with unified authentication and usage tracking.
POST
https://api.sandbase.ai/v1/api/facebook/company-adsModel ID
facebook/company-ads01
Input Schema
10 parameters · 0 required · 10 optional
| Parameter | Type | Required | Description |
|---|---|---|---|
cursor | string | Optional | Opaque pagination cursor from a previous response's nextCursor. |
pageId | string | Optional | Company's Ad Library page ID. Provide either pageId or companyName. · Min length: 1 |
sortBy | string | Optional | Sort order: impressions (highest first, the default) or recent (most recent). · Options: impressions, recent impressionsrecent |
status | string | Optional | Ad status filter. Defaults to ACTIVE. · Options: ALL, ACTIVE, INACTIVE ALLACTIVEINACTIVE |
country | string | Optional | Two-letter country code to scope results. Defaults to all countries. |
endDate | string | Optional | Filter to ads with impressions on or before this date, in YYYY-MM-DD format. |
language | string | Optional | Two-letter language code to filter ads (e.g. "EN", "ES", "FR"). |
mediaType | string | Optional | Creative media type filter. · Options: ALL, IMAGE, VIDEO, MEME, IMAGE_AND_MEME, NONE ALLIMAGEVIDEOMEMEIMAGE_AND_MEMENONE |
startDate | string | Optional | Filter to ads with impressions on or after this date, in YYYY-MM-DD format. |
companyName | string | Optional | Company name to search (e.g. "nike"). Exact-match and case-sensitive against the Meta Ad Library index; an advertiser with no indexed page returns found:false. · Min length: 1 |
02
Output Schema
| Field | Type | Description |
|---|---|---|
id | string | Unique identifier for the generation task |
status | string | Task status: pending, running, completed, failed, timeout |
model | string | Model used for the generation |
outputs | array | Array of output items |
outputs[].url | string | URL of the generated artifact |
outputs[].content_type | string | MIME type (e.g. image/png, video/mp4) |
error | object | null | Error details if failed, null on success |
error.type | string | Machine-readable error type code |
error.message | string | Human-readable error description |
03
Code Examples
Ready-to-run snippets
const apiKey = process.env.SANDBASE_API_KEY;
const response = await fetch("https://api.sandbase.ai/v1/api/facebook/company-ads", {
method: "POST",
headers: {
Authorization: `Bearer ${apiKey}`,
"Content-Type": "application/json",
},
body: JSON.stringify({
"pageId": "15087023444",
"sortBy": "recent"
}),
});
if (!response.ok) throw new Error(await response.text());
console.log(await response.json());