/spyfu/keywords/ad_history

POST /api/spyfu/keywords/ad_history

Price: 20 credits

Get the advertisers and Google Ads seen on a keyword, with ad copy, dates and positions

How to use it

Get the ad history of one keyword: every advertiser SpyFu saw bidding on it with the ads it ran (headline, text, landing URL, date, position), and the best-performing ads on the keyword.

Parameters

• access-token string required

Request body

• timeout integer — Max scrapping execution timeout (in seconds) (default: 300; min: 20; max: 1500)
• keyword string required — Keyword or SpyFu keyword URL (examples: "crm software", "https://www.spyfu.com/keyword/overview?query=crm+software"; minLength: 1)
• country_code string — Search market (UK, not GB) (default: "US"; one of: "AR", "AT", "AU", "BE", "BR", "CA", "CH", "CL", "CZ", "DE", "DK", "ES", "FI", "FR", "IE", "IN", "IT", "JP", "MX", "NL", "NO", "NZ", "PL", "PT", "SE", "SG", "TR", "UA", "UK", "US", "VE", "ZA")

Response

• @type string (default: "SpyfuKeywordAdHistory")
• keyword string required
• advertiser_count integer nullable
• advertisers array (default: [])
  • @type string (default: "SpyfuKeywordAdvertiser")
  • id string required
  • domain string required
  • ad_budget number nullable
  • coverage number nullable
  • leaderboard_share number nullable
  • ads_purchased_count integer nullable
  • ad_count integer nullable
  • ads array (default: [])
    • @type string (default: "SpyfuAd")
    • id string required
    • date string nullable
    • position integer nullable
    • text string nullable
    • domain string nullable
    • url string nullable
    • keyword string nullable
    • keyword_id string nullable
    • ad_count integer nullable
    • is_leaderboard boolean nullable
• top_ads array (default: [])
  • @type string (default: "SpyfuTopAd")
  • id string required
  • text string nullable
  • url string nullable
  • average_position number nullable
  • average_ad_count number nullable
  • leaderboard_count integer nullable
  • leaderboard_share number nullable
  • ads_served_share number 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 — SpyFu has no data for this keyword. 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.