Skip to main content
POST
/facebook/ads/search

Authorizations

access-token
string
header
required

API token from the dashboard

Headers

access-token
string
required

Body

application/json
query
string
required
Minimum string length: 1
count
integer
required
Required range: x >= 1
timeout
integer
default:300
Required range: 20 <= x <= 1500
country
string
default:US
Pattern: ^[A-Z]{2}$
ad_type
enum<string>
default:all
Available options:
all,
political_and_issue_ads
active_status
enum<string>
default:active
Available options:
active,
inactive,
all
media_type
enum<string>
default:all
Available options:
all,
image,
video,
meme,
none

Response

Successful Response

id
string
required
url
string
required
@type
string
default:FacebookAd
is_active
boolean
default:false
started_at
integer | null
ended_at
integer | null
platforms
string[]
country
string | null
categories
string[]
collation_count
integer | null
advertiser
object | null
creatives
object[]
text
string | null
caption
string | null
cta_text
string | null
cta_type
string | null
display_format
string | null
is_reshared
boolean
default:false
contains_sensitive_content
boolean
default:false
total_active_time
integer | null
branded_content
object | null
additional_info
object | null
currency
string | null
spend_range
string | null
reach_estimate
string | null
impressions_range
string | null
disclaimer_label
string | null
fev_info
object | null