Search skmtc…
⌘K
Docs
Sign in
APIs
Generators
Stacks
Projects
Docs
History
Schema
Generate
Filter operations
ads
3
alerts
9
apiKeys
5
audience
1
brands
62
get
/v1/brands/{brandId}/offer-calendar
The brand's storefront offer runs since its storefront was first captured: each run's start and end, kind, depth anyone gets and the deepest shown, code, and whether it recurs from a year earlier. Built nightly from the offer captures.
get
/v1/brands/{brandId}/pages/{pageId}/weekly
One linked Facebook page's ads for the brand per week, oldest first: live at the week's end and launched, null on a week the page was not reliably read.
get
/v1/brands/{brandId}/launch-grid
The brand's ads launched per page and day over the last `days` days, for its `top` pages by live ads, with each day's formats and angles; a day not reliably read is null.
get
/v1/brands/{brandId}/formats-by-week
The brand's ads launched per week by format (video, image, dynamic), oldest first; a gap week is null.
get
/v1/brands/{brandId}/partnership-ads
The brand's branded-content ads (run with a creator's page), live first, then by days live, with the creator.
get
/v1/brands/{brandId}/related
Brands linked to this one through a shared Facebook page, domain or operator, strongest first; a link through a media publisher or promoter page is marked noisy. A link is not an ownership claim.
get
/v1/brands/{brandId}/changes
What changed on the brand in the last `days` days, newest first, across its Meta ads, landing pages, catalog, TikTok Shop, split tests and site: one row per change with its lane and tier.
get
/v1/brands/{brandId}/channels
The counts behind the brand overview's channel tiles: Meta ads, landing pages, catalog, split tests, similar sites, Shop app and TikTok Shop, each with its 12-week series where one exists; a channel never read is read=false, not zero.
get
/v1/brands/{brandId}/funnel
The brand's funnel in counts: landing pages and those with live ads, with an offer, in a live split test, and live ads per lander type.
get
/v1/brands/{brandId}/landers
The brand's landing pages, most live ads first, with type, offer and first and last seen.
get
/v1/brands/{brandId}/pacing
The brand's launch pace and ad lifetimes (Kaplan-Meier: stopped within 7 days, live at 30) and the share carried by its top creatives, against size-matched peers. Observed lifetimes, not performance.
get
/v1/brands/{brandId}/proven
Whether the brand is Proven, gate by gate (tenure, traffic, social proof, ownership, churn), with each check's value and threshold and the network veto.
get
/v1/brands/{brandId}/brief
The brand's written week: one line per notable move, each claim with its value, status and source.
get
/v1/brands/weekly-moves
For up to 100 brands, the newest complete week's ads launched and stopped against the week before and the usual (median of the 4 before), with a Poisson z and the lead story kind.
get
/v1/brands/{brandId}/preparation
How far a newly added brand's first read has come: store, pages, ads, its first week, traffic and its first brief, each done, running or scheduled, with what was read so far.
get
/v1/brands/{brandId}/suggested-set
Up to 10 brands to watch beside this one: the largest in its category, size-matched peers, brands sharing its audience and those launching most. Never the brand itself or a shadow brand.
get
/v1/brands/{brandId}/cross-tab
The brand's labelled creatives cross-tabulated: format by presenter gender and narrative form by speaker mode, with the stored files, live files and live ads in each cell.
get
/v1/brands/index
Every public brand in one call (optionally within a category at any level), most active ads first: ids, names, domains, logos and category ids, ad counts (active, new and stopped in 7 days, total), the first ad's date, Similarweb's latest month, review counts, the share of active ads run from owned, whitelisted and shadow pages, and operator-network confidence. Refreshed daily; shares hourly.
get
/v1/brands/{brandId}
One brand (by id or slug) with its current ad statistics and its latest Similarweb month (monthly_visits, visits_change, traffic_month).
get
/v1/brands
Public brands, filterable by category, country and name, sorted by activity or Similarweb visits, each with its latest Similarweb month (monthly_visits, visits_change, traffic_month). preset=leaders keeps brands that held at least 40,000 monthly visits through the last 12 months, grew year over year and run at least 50 live ads from an own store. `meta.count` is the number of brands that match, so a table can show its pages.
get
/v1/brands/sitemap
Indexable brand pages for sitemap generation (slug, url, last update), optionally within a category at any level. With `similar_min`, only brands with at least that many Similarweb similar sites, most similar sites first.
get
/v1/brands/{brandId}/velocity
Weekly ad counts for one brand: every ISO week with an observed day. active_ads is the latest observed day's value; new_ads and retired_ads sum reliable days only (reliable_days, 0–7, says how many) — shade weeks with reliable_days 0.
get
/v1/brands/{brandId}/breakdown
Active ads by creative format for one brand.
get
/v1/brands/{brandId}/similar
Sites Similarweb rates as similar to this brand, by affinity, linked to tracked brands.
get
/v1/brands/{brandId}/trajectory
Similarweb monthly visits and the month's global / category rank, one point per data month, oldest first. Similarweb lags about two months; is_reconstructed marks a month derived from its month-over-month change chain.
get
/v1/brands/{brandId}/demographics
Similarweb audience gender and age shares for the brand's domain.
get
/v1/brands/{brandId}/tech-stack
Platform tools detected on the brand's site, by tool category then name.
get
/v1/brands/{brandId}/offers
The brand's current sitewide offers (free shipping, discounts, codes, subscribe-and-save, bundles, guarantees, sign-up offers, named sales), read from the announcement bar and pop-ups of its main storefront host, debounced over 3 captures and updated hourly. as_of is the latest capture day; since is when each offer was first shown in its current run. An empty list with as_of null means no current offer was read: either the storefront shows none or it was not captured.
get
/v1/brands/{brandId}/survival
How long the brand's ads stay live: the Kaplan-Meier median lifetime of every ad seen launching (stops observed, live ads censored), the share stopped within 7 days and still live at 30, and a log-rank test against its category; with the survival curves of its category, its level-3 type and each format (whole days to 90, with 95% bands). Observed lifetimes, not performance. Rebuilt nightly.
get
/v1/brands/{brandId}/offer-changes
The brand's storefront offer changes over the last `days` days, newest first: a sale or a discount starting, a new code, an offer ending, a free-shipping threshold moving, each on the day it was first shown (debounced over 3 captures of the main storefront host).
get
/v1/brands/{brandId}/signals
One public brand's grouped signals over the last `days` days, newest first, as radar.signals builds them for tracked brands: ads started, confirmed stops and link changes per day, active-ad ramps and drops, launch bursts, sales, new landing pages, new linked pages, new whitelisting pairs, format-mix shifts, long-running ads refreshed (capped at 3 days), and storefront offers started. Each carries evidence links.
get
/v1/workspaces/{ws}/tracked-brands
The workspace's tracked brands, newest first, each with its current public summary.
post
/v1/workspaces/{ws}/tracked-brands
Track a brand in a workspace; collection starts asynchronously.
get
/v1/workspaces/{ws}/tracked-brands/freshness
Freshness SLO status of the workspace's tracked brands, most overdue first: the last reliable read, when the next is due, and whether the cadence's SLO is breached.
delete
/v1/workspaces/{ws}/tracked-brands/{brandId}
Stop tracking a brand in a workspace; answers removed:false when it was not tracked.
get
/v1/brands/{brandId}/facebook-pages
Facebook pages linked to the brand with their servable role (quarantined links dropped, unservable claims as UNVERIFIED), followers and ad counts, most ads first.
get
/v1/brands/{brandId}/leakage
How many of the brand's active ads run on pages it does not own: totals over every page, and the ten largest third-party pages.
get
/v1/brands/{brandId}/copy-reuse
Ad body texts the brand runs that pages outside its linked set also run — at most twelve, by foreign ads.
get
/v1/brands/{brandId}/partnerships
Creators the brand ran branded content with, both directions, merged per creator, most ads first.
get
/v1/brands/{brandId}/partners
Third-party Facebook pages advertising the brand: whitelisted creators (Meta's branded-content label), partner pages, shadow pages, affiliate hubs and publishers, each with ad counts, first and last seen, whether it is active now and example ads. A page's role is served only where its claim passes the confidence bar; below it the page is listed as unverified_page with role null. Most active ads first; totals count every page by kind.
get
/v1/brands/{brandId}/creative-tests
A brand's creative tests: the ads it launched on the same day (Meta's start date), cohort by cohort, newest first, with how many are still active, stopped or unverified and which ads survived (still active 7 days or more after launch while a sibling stopped). Observed survival, not performance or spend. Answers 409 until the view's first nightly build.
get
/v1/brands/{brandId}/hooks
A brand's hook library: the opening lines of its creatives (the spoken hook, else the on-screen text of the first 3 seconds), each with its angle, format, creatives, ads, share still active, median observed days live and example ads, ranked by observed survival. Filter by format, production (ugc or produced), awareness, angle or a last-seen day. Observed survival, not performance or spend. Answers 409 until the view's first nightly build.
get
/v1/brands/{brandId}/benchmark
A brand against its category on eight observed measures: launch velocity (new ads a day), median observed survival, 14-day kill rate, refresh rate, video, image and carousel share of active ads, and whitelisting share. Each with the brand's value, the ads it rests on (n), the category's median and quartiles, the brand's percentile and a confidence level. Counts of observed ads and observed survival; never spend. Answers 409 until the view's first nightly build.
get
/v1/brands/{brandId}/creative-library
A sample of the brand's active ads with stored media (half the longest-running, half the newest; at most `sample`, answered as sample_cap), plus format, CTA and longevity totals over every active ad.
get
/v1/brand-thumbs
Up to four of each brand's newest live creatives with a stored image or poster. Every brand asked is answered; an empty list means none is stored.
get
/v1/brands/batch
brands.list's row for many brands in one read: summary, latest Similarweb month, stops in 7 days and page ownership. Every public brand asked is answered once, in the order asked; a ref naming no public brand is left out.
get
/v1/brand-velocity
brands.velocity for many brands in one read: each brand's weekly ad counts, as brands.velocity answers them. Every public brand asked is answered, in the order asked; `weeks: []` means no observed week.
get
/v1/brand-daily-activity
brands.dailyActivity for many brands in one read: each brand's daily active, new and retired ads, oldest first. Every public brand asked is answered, in the order asked; `days: []` means no observed day.
get
/v1/brand-creative-library
brands.creativeLibrary for many brands in one read: each brand's sample of active ads with stored media and its totals over every active ad, as brands.creativeLibrary answers them. Every public brand asked is answered, in the order asked.
get
/v1/brands/{brandId}/daily-activity
Daily active, new and retired ads for one brand, oldest first. Unreliable days carry reliable:false; read:true on such a day is an incomplete read (shade it), read:false a day with no read (draw a gap); days never observed are absent, not zero.
get
/v1/brands/{brandId}/split-tests
The testing tools installed on the brand's site and every test observed on their accounts: type, state and its basis, arms with configured allocations, the pages each acts on with the brand's active ads there, and the category's test-type profile. Configured and observed: it never says which arm did better. No price or shipping amount is served — a price test says it is one.
get
/v1/brands/{brandId}/store
The brand's public Shopify catalog as last read: the latest scan's contract (only an exhausted enumeration is the whole feed), products with variants, listed prices and the available flag as published, and twelve weeks of observed changes. A brand never scanned answers status not_collected, never an empty catalog.
get
/v1/brands/{brandId}/store/summary
What a brand overview shows of its Shopify store, computed over the whole catalog: the latest scan's contract, products listed now, twelve weeks of change counts and the latest changes (up to 100 from the last 30 days). The products are brands.store. A brand never scanned answers status not_collected.
get
/v1/brands/{brandId}/store/products
The brand's store products a page at a time, searched, filtered and sorted by the API: by last change (default), first seen, lead price (the lowest printed variant price), its compare-at, its discount, title or variant count. `availability` keeps the listed products, those whose every variant is purchasable (available), some (partial), none (unavailable), or those no longer listed (gone); `price` keeps those with a printed price or on sale. meta.count is every product that matches.
get
/v1/brands/{brandId}/store/changes
The brand's store changes in the last `days` days (1–84), a page at a time, newest first or by the largest price move, optionally one kind: new, price_cut, price_raise, unavailable (a variant became not purchasable) or gone (no longer listed). Each carries its product's page and image. meta.count is every change that matches.
get
/v1/facebook-pages/{pageId}
One Facebook page by its id: its role, followers, Instagram, live and total ads and promo codes as the public brand it is linked to serves them (brands.facebookPages), with every brand it is linked to. The brand is its primary link, else the one it runs the most ads for. 404 when no public brand links the page.
get
/v1/brands/{brandId}/store/products/{productId}/price-history
One product of the brand's store, its price over time: each day a new lowest listed variant price or compare-at was seen, oldest first, from the store's catalog reads (daily). Listed prices as the store prints them, not checkout prices. 404 when the brand has no store read or the product is not in it.
get
/v1/brands/{brandId}/tiktok-shop
The brand's TikTok Shop sales (US), from TikTok's public units-sold counters read daily: per linked shop, units sold per UTC day (exact, from the shop's own counter) and a GMV ESTIMATE as a low-high band from the prices listed that day, with the top tracked products. Never revenue: the counter excludes returned items and the page shows today's prices. History starts at the first read. A brand with no linked shop, or one not yet read on two days, answers status not_collected, never zero sales.
get
/v1/brands/{brandId}/shop
The brand's store on Shop (shop.com, Shopify's shopping app), as read from its public store page: the store's Shop ratings and reviews, the social and contact links it declares, its business address and retail locations, its top products in Shop's best-seller order with price, compare-at price and rating, and the brand kit the store publishes (colours, and logo, avatar, cover and wordmark copied to our CDN). The rank is a position, never a sales number; emails and phone numbers are not served. A brand with no linked store answers status not_collected.
get
/v1/brand-network
The shared-page network of one brand (it and its direct neighbours) or of one category (its public brands): brands, brand-to-brand links with their confidence and shared page count, and how many brands in a category have no link. Ownership claims are not part of it.
get
/v1/brands/{brandId}/reviews
The brand's reviews as its public review widgets (Okendo, Yotpo, Junip, Klaviyo Reviews, Stamped, Trustpilot, Judge.me, Loox) show them, from the daily read of the last 90 days: each widget's latest average rating, review count and star split, the weekly trend, and the newest reviews (title, body cut to 1,000 characters, date, verified, product, replied). No reviewer name is stored or served. A brand whose widgets were not read answers status not_collected, never zero reviews.
get
/v1/brands/{brandId}/accounts
The accounts the brand runs on other platforms (Instagram, Facebook, TikTok, YouTube, Shopify, Amazon, TikTok Shop, …) as the account registry links them, each with the latest public profile read where one exists: followers, following, posts and the verified badge. Followers are counts as the platform shows them, never reach.
briefs
3
categories
10
collections
9
creatives
15
me
1
notes
3
operators
4
pages
5
radar
9
rankings
17
reports
3
system
3
tools
7
brands
Copy
Copy Markdown
Copy Markdown
Copying…
Copied
Copy failed
Changes to The brand's branded-content ads (run with a creator's page), live first, then by days live, with the creator.
get
/v1/brands/{brandId}/partnership-ads
Oct 19, 2026
4fbe9d681caf
Revision changes
info
endpoint added