Skip to main content
GET
/
v1
/
marketing
/
share-of-shelf
See brand market share within a category
curl --request GET \
  --url https://api.syntalic.com/v1/marketing/share-of-shelf \
  --header 'Content-Type: application/json' \
  --data '
{
  "category": "electronics",
  "category_id": 1,
  "country": "us"
}
'
{}

Query Parameters

​
category
string
required

Product category (e.g., electronics, grocery, beauty). Fuzzy human-readable input — the resolver maps it through tier 1-4 (id → exact name → trigram → embedding kNN) to a canonical category_id. Pair with category_id if you have a deterministic id from a prior call.

Minimum string length: 1
​
category_id
integer

Deterministic category id. When set, bypasses the fuzzy resolver cascade and uses tier 1 (id lookup) directly. Agents that learned a canonical id from a prior call's resolved.category_id should pin it here for round-trip stability.

Required range: x >= 1
​
country
enum<string>
default:us

Country (us or ca)

Available options:
us,
ca

Body

application/json

Query parameters as JSON (alternative to URL query string for agents that prefer body-based invocation).

​
category
string
required

Product category (e.g., electronics, grocery, beauty). Fuzzy human-readable input — the resolver maps it through tier 1-4 (id → exact name → trigram → embedding kNN) to a canonical category_id. Pair with category_id if you have a deterministic id from a prior call.

Minimum string length: 1
Example:

"electronics"

​
category_id
integer

Deterministic category id. When set, bypasses the fuzzy resolver cascade and uses tier 1 (id lookup) directly. Agents that learned a canonical id from a prior call's resolved.category_id should pin it here for round-trip stability.

Required range: x >= 1
Example:

1

​
country
enum<string>
default:us

Country (us or ca)

Available options:
us,
ca
Example:

"us"

Response

Share of shelf data

The response is of type object.