Skip to main content
GET
Share of social conversation, and how it is moving.

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,
category,
creator,
product_type,
topic,
momentum,
emerging,
week
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

Brand name (e.g., Sony, Samsung, Nike)

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}$
status
enum<string>
default:all

Restrict to one movement class. new = emerging-brand detection.

Available options:
new,
rising,
falling,
all
product_type
string

Only brands with a product typed at or under this Shopify taxonomy path.

subject_kind
enum<string>
default:brand

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

Available options:
brand,
category
weeks
integer
default:26

How many trailing ISO weeks to return.

Required range: 1 <= x <= 104

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.