Skip to main content
GET
Marketing practices creators describe brands using, by shelf

Query Parameters

category
string

Optional. Shopify taxonomy path, as a join key or a display path: a root or any node under it. Reads the practices shown on a brand filed at that node or below it. Leave it out (or send all) to read every practice of the run, which is a superset of any category. A node no practice was shown under is refused free, with the published scopes that contain it. Retired browse roots are refused with the root to use instead.

channel
enum<string>

Only practices in this channel of the marketing-v2 vocabulary.

Available options:
email,
retail,
supply,
brand_launch,
growth,
social,
site,
branding,
customer
lane
enum<string>

Only practices in this lane (a group of practices within a channel).

Available options:
launch,
collab,
newsletter,
content,
offer,
hero,
footer,
design,
cadence,
getting_in,
manufacturer_search,
prelaunch,
scaling,
formats,
creators,
planning,
conversion,
identity,
service
practice
enum<string>

Only this practice, by its vocabulary id.

Available options:
restock_as_launch,
launch_arc,
collab_arc,
founder_letter,
recipe_click_through,
calendar_content,
soft_sell_guide,
discount_in_hero,
offer_steps,
immersive_hero,
buttons_above_fold,
category_buttons,
final_cta,
bright_visuals,
editorial_layout,
stated_cadence,
retail_ready_first,
mid_tier_first,
buyer_timelines,
door_by_door,
retailer_discovery_event,
long_supplier_list,
pitch_like_investor,
preorder_list,
build_in_public,
launch_event_creators,
channel_ladder,
named_series,
founder_on_camera,
questions_to_content,
gifting_not_paid,
content_system,
per_buyer_pages,
homepage_headline,
origin_story_research,
packaging_for_use,
founder_handles_service
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.

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 category=, not with it. The answer is about that one node, as with category=.

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

Response

Marketing practices

category
string

The SPT node asked for, or all for the whole run.

window_days
integer
platform
string
organic_only
boolean
channel
string | null
lane
string | null
practice
string | null
vocab_version
string
Example:

"marketing-v2"

practices
object[]
total
integer

Practices in scope before limit.

truncated
boolean
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