POST
Fetch ad creatives, walk an ad archive, or resolve an advertiser

Authorizations

Authorization
string
header
default:tok_public_demo
required

Send a workspace API token in the Authorization: Bearer <token> header.

Keys carry the satk_ prefix and spend your organization's credit balance. GET /v1/public/balance reports what is left.

Test-mode keys (satk_test_), which drew on a separate self-refilling allowance, have been retired and no longer authenticate.

Headers

Idempotency-Key
string

Optional deduplication key, scoped to your organization. Re-sending a request with a key that was already used returns the original job instead of creating and charging for a second one.

Supersedes the idempotencyKey body field, which remains supported as a deprecated alias. If both are present, this header wins.

Maximum string length: 255

Body

application/json

At least one of domain, companyName, or advertiserId is required. An advertiserId is the most precise input and is not filtered by landing domain.

domain
string
required

Company domain. On Meta it attributes keyword-search results to the right advertiser; on Google it IS the query — the Transparency Center is searchable by the domain an ad lands on.

wait
boolean
default:true

Wait for a terminal response before falling back to async job polling.

waitTimeoutMs
integer

Optional client-requested sync wait timeout, bounded by the server maximum.

webhookUrl
string<uri>

Optional public callback URL for terminal job delivery. Available to every organization.

Naming a URL here registers it as a webhook endpoint if it is not registered already, so the signing secret exists before the first delivery does. Fetch it from GET /v1/public/webhooks/endpoints/{endpointId}/secret, or register the endpoint up front with POST /v1/public/webhooks/endpoints to have the secret in hand before you run anything.

Deliveries carry X-Scrapebento-Signature, an HMAC-SHA256 over "<timestamp>.<body>" under that endpoint's own secret, so the secret you need to verify your deliveries cannot forge anyone else's. Every attempt is recorded in GET /v1/public/webhooks/deliveries and can be re-sent from there.

idempotencyKey
string
deprecated

Deprecated alias for the Idempotency-Key header, which is the conventional transport and takes precedence when both are sent. Still honoured so existing integrations keep working.

Maximum string length: 255
cacheTtlSec
integer

How long this result may be reused, in seconds. Capped at 7 days (604800); larger values are clamped.

Omit it to accept the per-kind server default. Slow-moving kinds cache by default — infra and brand for 6h, seo, sitemap, site, and producthunt for 1h, and hn_search, hn_post, and rss for 5m. Everything else defaults to no caching.

A cached result is charged at the same rate as a fresh scrape, so the TTL is how stale an answer you can be billed for. Send 0 to prevent this result being cached, and fresh: true to bypass an existing cache entry on read.

Required range: 0 <= x <= 604800
fresh
boolean

Bypass cache and force a new scrape or search execution.

op
enum<string>
default:creatives

creatives returns an advertiser's current ad creatives. archive walks their whole back-catalogue, spending many upstream page loads inside the single job. It has no keyword fallback, so it needs the identifier that platform's archive is keyed on: advertiserId for Meta, domain for Google. resolve maps a company to platform advertiser ids, returning not_found as a real, cacheable answer.

Available options:
creatives,
archive,
resolve
platform
enum<string>

Omit on creatives to query every platform and merge the results. archive and resolve each answer about a single platform and default to meta.

Available options:
meta,
google
companyName
string
advertiserId
string

Meta Page id (numeric) or Google advertiser id (AR…). On Meta it skips search entirely and returns that Page's ads; on Google it filters the domain's ads down to that advertiser, which is what keeps affiliates out of the result.

Pattern: ^[A-Za-z0-9_-]{1,64}$
facebookUrl
string<uri>

Official Facebook Page URL, used as a resolution hint. Must be a facebook.com or fb.com URL.

country
string
default:ALL

ISO-3166 alpha-2 code, or ALL for every country.

activeStatus
enum<string>
default:all
Available options:
all,
active,
inactive
cursor
string

Forward cursor from a prior response's nextCursor. Accepted for forward compatibility, but neither platform hands one back in practice: Meta results are read from the Ad Library's server-rendered page, which exposes no usable cursor, and Google follows its own cursor inside the job rather than returning a position that only means anything alongside the region and date bounds that produced it. resultComplete (in both the result body and meta) is false when more ads exist than the response carries — retire ads you did not see only when it is true.

limit
integer
default:30
Required range: x <= 100
maxLoads
integer
default:40

op=archive only. Page loads the window walk may spend. One load returns 30 ads, so a back-catalogue of N ads costs roughly N/30 loads plus the splits that find the window boundaries; a 97-ad advertiser measured at ~23. The walk also stops early once a branch stops yielding new ads.

Required range: x <= 120
floorMonths
integer
default:24

op=archive only. How far back the walk reaches. Wider costs proportionally more loads.

Required range: x <= 120

Response

Ad snapshot completed and returned a terminal response.

data
object
required