/linkedin/ad_library/ads/search

POST /api/linkedin/ad_library/ads/search

Price: 5 credits

Search the LinkedIn Ad Library by keyword, advertiser, payer, country and date

How to use it

Search the LinkedIn Ad Library (linkedin.com/ad-library) for ads. Filter by keyword (text in the ad), company_ids (numeric advertiser company id), payer, countries (ISO-3166 alpha-2), date_option time window, impressions range (min and max together), targeting parameter categories that the ad included or excluded (language, location, audience, demographic, company, education, job, interests_and_traits) and sort order. At least one of keyword, company_ids or payer is required. Returns id, url, advertiser, ad_format, creative_type, text, headline, cta_text, image per ad card. Fetch a single ad by id to get full creatives, payer and ad transparency (run dates, impressions, targeting).

Parameters

• access-token string required

Request body

• timeout integer — Max scrapping execution timeout (in seconds) (default: 300; min: 20; max: 1500)
• keyword string nullable — Word or phrase in the ad text (examples: "cloud"; minLength: 1)
• company_ids array nullable — Numeric LinkedIn company id(s) of the advertiser (examples: [1441])
• payer string nullable — Name of the entity that paid for the ad (minLength: 1)
• countries array nullable — ISO-3166 alpha-2 country codes, uppercase (examples: ["US"])
• date_option string nullable — Time window of when the ads ran (one of: "last-30-days", "current-month", "current-year", "last-year")
• impressions_min integer nullable — Lower bound of the ad impressions range; requires impressions_max (min: 0)
• impressions_max integer nullable — Upper bound of the ad impressions range; requires impressions_min (min: 0)
• impressions_unit string — Unit applied to impressions_min / impressions_max (default: "Thousand"; one of: "Thousand", "Million")
• targeting_included array nullable — Only ads that targeted these audience parameter categories (one of: "LANGUAGE", "LOCATION", "AUDIENCE", "DEMOGRAPHIC", "COMPANY", "EDUCATION", "JOB", "INTERESTS_AND_TRAITS"; examples: ["LANGUAGE"])
• targeting_excluded array nullable — Only ads that excluded these audience parameter categories (one of: "LANGUAGE", "LOCATION", "AUDIENCE", "DEMOGRAPHIC", "COMPANY", "EDUCATION", "JOB", "INTERESTS_AND_TRAITS"; examples: ["COMPANY"])
• sort string — Result ordering by ad date (default: "newest"; one of: "newest", "oldest")
• count integer required — Max result count (examples: 20; min: 1)

Response

• @type string (default: "LinkedinAd")
• id string required
• url string required
• advertiser object nullable
  • @type string (default: "LinkedinAdvertiser")
  • id string nullable
  • name string nullable
  • image string nullable
  • company_url string nullable
• is_promoted boolean (default: false)
• ad_format string nullable
• creative_type string nullable
• text string nullable
• headline string nullable
• cta_text string nullable
• image string nullable
• video string nullable
• video_preview string nullable
• payer string nullable
• ran_from string nullable
• ran_to string nullable
• impressions string nullable
• impressions_by_country array (default: [])
  • @type string (default: "LinkedinAdCountryImpressions")
  • country string required
  • percentage integer nullable
• targeting object nullable
  • @type string (default: "LinkedinAdTargeting")
  • segments array (default: [])
    • @type string (default: "LinkedinAdTargetingSegment")
    • name string required
    • value string nullable
  • parameters array (default: [])
    • @type string (default: "LinkedinAdTargetingParameter")
    • name string required
    • targeted boolean (default: false)
    • excluded boolean (default: false)
• creatives array (default: [])
  • @type string (default: "LinkedinAdCreative")
  • creative_type string nullable
  • image string nullable
  • video string nullable
  • video_preview string nullable
  • headline string nullable
  • cta_text string nullable

Errors

• 422 — The request body did not validate Check the fields against this schema. A URN with the wrong prefix is the most common cause.
• 408 — The request ran past its time limit Raise `timeout` in the request body, up to the maximum this endpoint documents. Lowering `count` or turning off the `with_*` flags also helps, because less work finishes sooner.
• 412 — The entity was not found, or a precondition failed Retrying will not help: either the entity does not exist, or the input points at a different one.
• 429 — Too many requests: a rate limit or a usage window is exhausted When the response carries an X-Retry-After header, wait that many seconds and retry: the same number is in the body as `detail.retry_after`, and the limit clears once that window passes. The message in the body names the limit that was hit.
• 500 — Something broke on our side Retrying will not help. If it keeps happening, send us the X-Request-ID from the response headers.
• 529 — Rate limit reached, or the endpoint is overloaded Wait at least 30 seconds, then retry.

Response headers

• X-Error — Error message text (present only on error)
• X-Request-ID — Unique request identifier
• X-Execution-Time — Execution time in seconds
• X-Result-Count — How many records the body carries. 0 means an empty result, which is a normal answer and not by itself an error. A non-zero count can come back together with X-Error when the failure happened partway through — read this header and X-Error independently.
• X-Total-Available-Results — How many records exist for this query, when the endpoint can say. On a `dry_run` request this is the answer and the body is empty. It saturates: the endpoint's documented maximum means 'at least that many', any smaller number is exact.
• X-Warning — Present when the request body carried keys this endpoint does not document. They were ignored, so any filter you meant to apply through them did not apply. Check the spelling against this schema and retry.
• X-Retry-After — Seconds to wait before retrying. Present only on 429.