Skip to main content
GET
Weekly mentions/views time series for one subject

Query Parameters

subject_kind
enum<string>
default:brand

What kind of subject to chart. Brand or category only.

Available options:
brand,
category
subject
string

The subject key (brand_key). Required unless subject_kind=category, where it defaults to category.

category
string

Shopify taxonomy path the subject is scoped to: a root or any node under it.

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.

weeks
integer
default:26

How many trailing ISO weeks to return.

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

A shelf by id, from GET /v1/ontology/resolve (a category match's id). Send it instead of category=, not with it. The answer is about that one node, as with category=.

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

The brand to chart, by id, from GET /v1/ontology/resolve (a brand match's id), with subject_kind=brand (the default). Send it instead of subject=, not with it.

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

Response

Social series

subject_kind
string
subject
string
category
string
platform
string
organic_only
boolean
weeks
integer
series
object[]
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