Skip to main content
GET
Search
💳 1 credit per request

Authorizations

X-API-Key
string
header
required

API key for authentication. Format: sk_live_xxxxxxxxxxxxx

Get your API key from the Dashboard.

Query Parameters

query
string
required

Keyword to search for

Example:

"running"

sort_by
enum<string>

Sort by impressions (high to low), or Most Recent (relevancy_monthly_grouped). Defaults to impressions.

Available options:
total_impressions,
relevancy_monthly_grouped
Example:

"total_impressions"

search_type
enum<string>

If you want to search by exact phrase or not

Available options:
keyword_unordered,
keyword_exact_phrase
Example:

"keyword_unordered"

ad_type
enum<string>

Search for all ads or only political and issue ads

Available options:
all,
political_and_issue_ads
Example:

"all"

country
string

This can only be one country. It has to be the 2 letter code for the country. It defaults to ALL.

Example:

"ALL"

status
enum<string>

Status of the ad. Defaults to ACTIVE.

Available options:
ALL,
ACTIVE,
INACTIVE
Example:

"ACTIVE"

media_type
enum<string>

Media type of the ad. Defaults to ALL. Meme just means the ad has text and an image. No clue why they call it meme.

Available options:
ALL,
IMAGE,
VIDEO,
MEME,
IMAGE_AND_MEME,
NONE
Example:

"ALL"

start_date
string

Impressions start date. Needs to be in YYYY-MM-DD format.

Example:

"2025-01-05"

end_date
string

Impressions end date. Needs to be in YYYY-MM-DD format.

Example:

"2025-02-16"

cursor
string

Cursor to paginate through results

Example:

"AQHRYLVDkoMkvGv7yK1rcce-vJmKiKv330R4v3j9KHSOaYvmF1bq1QkotG0rgW8Fkrj-"

trim
boolean

Set to true for a trimmed down version of the response

Example:

false

Response

Successful response

Key Response Fields:

  • data.searchResults[0].ad_archive_id: The actual ad ID (use this — ad_id is always null)
  • data.searchResults[0].is_active: Whether the ad is currently running
  • data.searchResults[0].page_id: Facebook page ID running the ad
  • data.searchResults[0].page_name: Facebook page name
  • data.searchResults[0].start_date_string: ISO timestamp of when the ad started
  • data.searchResults[0].end_date_string: ISO timestamp of when the ad ended or will end
  • data.searchResults[0].publisher_platform: Platforms the ad runs on
  • data.searchResults[0].snapshot.title: Ad headline/title
  • data.searchResults[0].snapshot.body.text: Ad body copy
  • data.searchResults[0].snapshot.cta_text: Call-to-action button text
  • data.searchResults[0].snapshot.cards[0].original_image_url: Ad creative image URL
  • data.searchResultsCount: Total number of matching ads found
  • data.cursor: Pagination cursor — pass as cursor to get further results