Skip to main content
GET
What posts say, as labels: launches, reviews, stance, names, practices.

Query Parameters

subject
string

What the question is about: an id (spt:, gpc:, brand:, retailer:, entity:) or a name. It is sent to the answering route as the parameter of its kind (an spt: id as spt, a brand: id as brand_id, a name as the route's name parameter), so send it OR that parameter, not both. Which kinds a split takes is in x-syntalic-presets; a kind it does not take is refused before anything is billed.

by
enum<string>
default:brand

How the answer is split. Each value is answered by one existing route; see x-syntalic-presets.

Available options:
brand,
product_name,
practice
category
string

Shopify taxonomy path, as a join key or a display path: a root (food-beverages-tobacco) or any node under it. A brand is filed at one node and counted there and at every ancestor, so each depth is its own scope. A node no tracked brand sits under is refused free, with the published scopes that contain it. Retired browse roots (grocery-gourmet-food, ...) are refused with the root to use instead.

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 this brand. Matched ignoring case and punctuation.

Minimum string length: 1
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]+)*$
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}$
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
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

Response

The answer of the route that by selected, unchanged. The X-Syntalic-Preset response header names that route; its own path in this document has the response schema.

The response is of type object.