Skip to main content
POST
Trigger Ad Library Scrapes

Authorizations

Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Body

application/json
scrapers
string[]
Maximum array length: 10
website_url
string | null
Maximum string length: 2048
country
string | null
Maximum string length: 8
start_time
end_time
sort_type
string | null
Maximum string length: 80
active_status
string | null
Maximum string length: 20
brand_names
string[]
Maximum array length: 200
brand_domains
string[]
Maximum array length: 200
page_ids
string[]
Maximum array length: 200
page_urls
string[]
Maximum array length: 200
total_limit
integer
default:100
Required range: 1 <= x <= 10000
page_size
integer
default:100
Required range: 1 <= x <= 100
meta_method
string | null
Maximum string length: 40

Response

Successful Response

requested_at
string<date-time>
required
enqueued
integer
required
skipped
integer
required
website_url
string | null
jobs
AdminAdLibraryScrapeJob · object[]
skipped_items
AdminAdLibraryScrapeSkippedItem · object[]