Skip to main content
POST
Ad-library search

Authorizations

Authorization
string
header
required

A personal API key (adside_pat_…) or a token from adside login. Either carries the permissions of the person it belongs to.

Path Parameters

workspaceId
string
required
Minimum string length: 1

Body

application/json
runId
string

Check on a scrape this tool started earlier. When set, every other field is ignored.

Minimum string length: 1
brandName
string

The brand or company name. Required unless runId is set.

Required string length: 1 - 120
channel
enum<string>

Which ad library to search. Required unless runId is set.

Available options:
META,
GOOGLE,
LINKEDIN
domain
string

The brand's website domain, for example nike.com. Required for GOOGLE.

Required string length: 3 - 253
metaPageId
string

The brand's numeric Facebook page id. Required for META.

Pattern: ^\d+$
startScrape
boolean
default:false

Set to true to start a paid scrape when the brand's ads are not already collected. Leave false to only read what is cached.

limit
integer
default:10

How many ads to return (max 25).

Required range: 1 <= x <= 25
confirmationToken
string

Response

200 - application/json

Success

text
string
required