Skip to main content
GET
Facebook Adlibrary Search Ads
Beta catalog endpoint. Provider activation and live verification are in progress. An unavailable operation returns HTTP 503 and uses no credits.

Authorizations

x-api-key
string
header
required

Headers

Cache-Control
string
Idempotency-Key
string

Query Parameters

query
string
required
sort_by
enum<string>
Available options:
total_impressions,
relevancy_monthly_grouped
search_type
enum<string>
Available options:
keyword_unordered,
keyword_exact_phrase
ad_type
enum<string>
Available options:
all,
political_and_issue_ads
country
string
status
enum<string>
Available options:
ALL,
ACTIVE,
INACTIVE
media_type
enum<string>
Available options:
ALL,
IMAGE,
VIDEO,
MEME,
IMAGE_AND_MEME,
NONE
start_date
string
end_date
string
cursor
string
trim
boolean

Response

Successful response. data is specific to this operation.

success
boolean
required
platform
string
required
endpoint
string
required
credits_used
integer
required
Required range: x >= 0
credits_remaining
integer | null
required
request_id
string
required
cached
boolean
required
data
object
required

Operation-specific data. Fields depend on the endpoint and upstream response; unavailable metrics may be null.