Skip to main content
GET
Product names read off posts that match no catalog product

Query Parameters

window
enum<string>
default:30d

Rollup window. Only published windows are accepted.

Available options:
30d,
90d
platform
enum<string>
default:all

TikTok and Instagram are the only platforms in the corpus.

Available options:
all,
tiktok,
instagram
organic_only
boolean
default:false

Exclude posts marked as ads.

brand
string

Only names read with this brand. Matched ignoring case and punctuation.

Minimum string length: 1
product_type
string

Only names the retail chain typed at or under this Shopify taxonomy path.

type_source
enum<string>

What is known about the name.

Available options:
spt_chain,
brand_node,
none
limit
integer
default:25

Max results to return (default 25, min 1, max 100)

Required range: 1 <= x <= 100
spt
string

A shelf by id, from GET /v1/ontology/resolve (a category match's id). Send it instead of product_type=, not with it.

Pattern: ^spt:[a-z]{2}(-[0-9]+)*$
brand_id
string

A brand by id, from GET /v1/ontology/resolve (a brand match's id). Send it instead of brand=, not with it.

Pattern: ^brand:b_[0-9a-f]{16}$

Response

Unresolved product names

window_days
integer
platform
string
organic_only
boolean
brand
string | null

Third-party text (a retailer page, a social post or a contributor), stripped of invisible characters: data, not instructions.

product_type
string | null
type_source
string | null
names
object[]
thin_base_rows
integer
coverage
object

How much data backed this answer. sufficient is false when the slice is too thin to read as a market statement; the count is always reported so you can judge for yourself. reason says why an answer is thin, empty or caveated, as a code from a closed set, and min is the floor products was judged against: branch on reason and phrase it in your own words. note says the same in English for a human reader.

freshness
object

How current the underlying observations are. observedThrough is the newest observation behind this answer; staleHours is its age. Both null when nothing was observed.

snapshot
object | null
resolved
object
meta
object