curl --request GET \
--url https://api.syntalic.com/v1/measures/assortmentimport requests
url = "https://api.syntalic.com/v1/measures/assortment"
response = requests.get(url)
print(response.text)const options = {method: 'GET'};
fetch('https://api.syntalic.com/v1/measures/assortment', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://api.syntalic.com/v1/measures/assortment",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "GET",
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"net/http"
"io"
)
func main() {
url := "https://api.syntalic.com/v1/measures/assortment"
req, _ := http.NewRequest("GET", url, nil)
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.get("https://api.syntalic.com/v1/measures/assortment")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.syntalic.com/v1/measures/assortment")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Get.new(url)
response = http.request(request)
puts response.read_body{
"category": "apparel-accessories",
"country": "us",
"currency": "USD",
"total_products": 2980,
"brands": [
{
"brand": "JoinUS",
"product_count": 357,
"share_pct": 12
},
{
"brand": "Cotopaxi",
"product_count": 230,
"share_pct": 7.7
}
],
"shelf": {
"source": "spt_node_shelf",
"readable": true,
"reason": "readable",
"node": "apparel-accessories",
"failing": [],
"basis": "store product pages seen in the last 30 days at retailers, brands' own stores left out",
"counts": {
"pages_on_shelf": 2981,
"other_brands": 304,
"retailers": 62,
"retailers_read": 55,
"own_store_pages_excluded": 16312,
"stale_pages_excluded": 3887
},
"floor": {
"retailers": 3,
"products": 100,
"other_brands": 10,
"fresh_days": 30
}
},
"coverage": {
"products": 2980,
"sufficient": true,
"counted": "retailer product pages"
},
"freshness": {
"observedThrough": "2026-11-19T07:22:02.239Z",
"staleHours": 3
},
"quality": {
"platform": "shopify",
"country": "us",
"category_root": "apparel-accessories",
"quality_status": "serving",
"is_serving_eligible": true,
"priced_product_count": "172268",
"recent_priced_product_count": "163526"
},
"resolved": {
"category_id": null,
"category_path": "apparel-accessories",
"match_source": "slug",
"match_confidence": 0.35,
"alternates": []
},
"meta": {
"served_from": "cache",
"freshness_seconds": 10912,
"schema_version": "v3",
"computed_at": "2026-11-19T10:23:54.676Z",
"publish_id": "0f6dbfc5-4a04-49b5-9a4e-257d6af4b0c4",
"published_at": "2026-11-19T07:56:57.632Z"
}
}{
"type": "<string>",
"title": "Bad Request",
"status": 400,
"detail": "<string>",
"instance": "<string>",
"error": {
"code": "<string>",
"message": "<string>",
"details": {}
}
}{
"type": "<string>",
"title": "Payment Required",
"status": 402,
"detail": "<string>",
"instance": "<string>",
"error": {
"code": "<string>",
"message": "<string>",
"details": {}
}
}{
"type": "<string>",
"title": "Not Found",
"status": 404,
"detail": "<string>",
"instance": "<string>",
"error": {
"code": "<string>",
"message": "<string>",
"details": {}
}
}{
"type": "<string>",
"title": "Conflict",
"status": 409,
"detail": "<string>",
"instance": "<string>",
"error": {
"code": "<string>",
"message": "<string>",
"details": {}
}
}{
"type": "<string>",
"title": "Unprocessable Content",
"status": 422,
"detail": "<string>",
"instance": "<string>",
"error": {
"code": "<string>",
"message": "<string>",
"details": {}
}
}{
"type": "<string>",
"title": "Too Many Requests",
"status": 429,
"detail": "<string>",
"instance": "<string>",
"error": {
"code": "<string>",
"message": "<string>",
"details": {}
}
}{
"type": "<string>",
"title": "Internal Server Error",
"status": 500,
"detail": "<string>",
"instance": "<string>",
"error": {
"code": "<string>",
"message": "<string>",
"details": {}
}
}{
"type": "<string>",
"title": "Service Unavailable",
"status": 503,
"detail": "<string>",
"instance": "<string>",
"error": {
"code": "<string>",
"message": "<string>",
"details": {}
}
}What is on the shelf, and who holds it.
What is on the shelf, and who holds it. A measure is one metric family asked one way: by picks the split, subject is what it is about, and every other parameter is the answering route’s own. The answer is that route’s answer, unchanged, and X-Syntalic-Preset names it. An unknown by, or a subject the split cannot take, is refused before anything is billed, with the valid list. by=brand: each brand’s share of the shelf, by product count, answered by /v1/marketing/share-of-shelf. by=concentration: how concentrated the shelf is: HHI, CR4, effective brands, answered by /v1/analyst/category-concentration. by=category: what a brand sells, counted per category, answered by /v1/marketing/brand-breakdown. by=retailer: which chains carry a brand or a shelf, and how much of it, answered by /v1/marketing/retailer-assortment. by=availability: out-of-stock rate per chain (aggregate_by=category_root for per category), answered by /v1/marketing/availability-index.
curl --request GET \
--url https://api.syntalic.com/v1/measures/assortmentimport requests
url = "https://api.syntalic.com/v1/measures/assortment"
response = requests.get(url)
print(response.text)const options = {method: 'GET'};
fetch('https://api.syntalic.com/v1/measures/assortment', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://api.syntalic.com/v1/measures/assortment",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "GET",
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"net/http"
"io"
)
func main() {
url := "https://api.syntalic.com/v1/measures/assortment"
req, _ := http.NewRequest("GET", url, nil)
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.get("https://api.syntalic.com/v1/measures/assortment")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.syntalic.com/v1/measures/assortment")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Get.new(url)
response = http.request(request)
puts response.read_body{
"category": "apparel-accessories",
"country": "us",
"currency": "USD",
"total_products": 2980,
"brands": [
{
"brand": "JoinUS",
"product_count": 357,
"share_pct": 12
},
{
"brand": "Cotopaxi",
"product_count": 230,
"share_pct": 7.7
}
],
"shelf": {
"source": "spt_node_shelf",
"readable": true,
"reason": "readable",
"node": "apparel-accessories",
"failing": [],
"basis": "store product pages seen in the last 30 days at retailers, brands' own stores left out",
"counts": {
"pages_on_shelf": 2981,
"other_brands": 304,
"retailers": 62,
"retailers_read": 55,
"own_store_pages_excluded": 16312,
"stale_pages_excluded": 3887
},
"floor": {
"retailers": 3,
"products": 100,
"other_brands": 10,
"fresh_days": 30
}
},
"coverage": {
"products": 2980,
"sufficient": true,
"counted": "retailer product pages"
},
"freshness": {
"observedThrough": "2026-11-19T07:22:02.239Z",
"staleHours": 3
},
"quality": {
"platform": "shopify",
"country": "us",
"category_root": "apparel-accessories",
"quality_status": "serving",
"is_serving_eligible": true,
"priced_product_count": "172268",
"recent_priced_product_count": "163526"
},
"resolved": {
"category_id": null,
"category_path": "apparel-accessories",
"match_source": "slug",
"match_confidence": 0.35,
"alternates": []
},
"meta": {
"served_from": "cache",
"freshness_seconds": 10912,
"schema_version": "v3",
"computed_at": "2026-11-19T10:23:54.676Z",
"publish_id": "0f6dbfc5-4a04-49b5-9a4e-257d6af4b0c4",
"published_at": "2026-11-19T07:56:57.632Z"
}
}{
"type": "<string>",
"title": "Bad Request",
"status": 400,
"detail": "<string>",
"instance": "<string>",
"error": {
"code": "<string>",
"message": "<string>",
"details": {}
}
}{
"type": "<string>",
"title": "Payment Required",
"status": 402,
"detail": "<string>",
"instance": "<string>",
"error": {
"code": "<string>",
"message": "<string>",
"details": {}
}
}{
"type": "<string>",
"title": "Not Found",
"status": 404,
"detail": "<string>",
"instance": "<string>",
"error": {
"code": "<string>",
"message": "<string>",
"details": {}
}
}{
"type": "<string>",
"title": "Conflict",
"status": 409,
"detail": "<string>",
"instance": "<string>",
"error": {
"code": "<string>",
"message": "<string>",
"details": {}
}
}{
"type": "<string>",
"title": "Unprocessable Content",
"status": 422,
"detail": "<string>",
"instance": "<string>",
"error": {
"code": "<string>",
"message": "<string>",
"details": {}
}
}{
"type": "<string>",
"title": "Too Many Requests",
"status": 429,
"detail": "<string>",
"instance": "<string>",
"error": {
"code": "<string>",
"message": "<string>",
"details": {}
}
}{
"type": "<string>",
"title": "Internal Server Error",
"status": 500,
"detail": "<string>",
"instance": "<string>",
"error": {
"code": "<string>",
"message": "<string>",
"details": {}
}
}{
"type": "<string>",
"title": "Service Unavailable",
"status": 503,
"detail": "<string>",
"instance": "<string>",
"error": {
"code": "<string>",
"message": "<string>",
"details": {}
}
}Query Parameters
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.
Product category in the Shopify product taxonomy. Accepts a display path (e.g. 'Electronics > Computers > Laptops'), its slug form (e.g. 'electronics/computers/laptops'), a single path segment (e.g. 'laptops', 'headphones'), or an everyday shelf name (e.g. 'apparel', 'beauty', 'grocery'); matched against the catalog's category tree (exact node, subtree, or whole path segment). Also accepts a GS1 GPC code (exactly 8 digits, e.g. '10001159') to filter by PRODUCT TYPE instead of by shelf placement — the same product type is shelved under different categories by different retailers, so a category filter answers from a fraction of the data while a GPC code spans them. Coarser codes (class/family/segment) match every brick beneath them. Resolve a phrase to a code with /v1/reference/classify?q=... ; when a code is used, resolved.match_source is 'gpc'. Some product types are filed under more than one department (e.g. Protein Bars under both Food and Health & Beauty); add include_homes=true to read every home of such a type as one shelf.
1Optional. Pin the answer to a serving publish: pass meta.publish_id from an earlier answer. When the served snapshot has moved on, or cannot be confirmed, the request is answered 409 PUBLISH_CHANGED naming the current publish, before any payment challenge and free. Use it to keep several answers on one snapshot.
1A product type by GS1 GPC id, from GET /v1/ontology/resolve (a product_type match's id). Covers EVERY shelf the type is filed under, so a type shelved in two departments is one scope (category=<8 digits> filters by browse-node placement). Send it instead of category= or spt=, not with them.
^gpc:[0-9]{8}$A chain by id, from GET /v1/ontology/resolve (a retailer match's id): the chain (seller_norm) whatever lane its listings were scraped through, never a lane. retailer= matches the scrape lane, so a Shopify store's chain can only be asked for by id (#1090). Send it instead of retailer=, not with it.
^retailer:[a-z0-9]{1,64}$Brand name (e.g., Sony, Samsung, Nike) A name that is nowhere in the catalog under that spelling is refused before payment, when the request arrives without payment attached (the normal 402 flow): a 404 whose error.details.alternates lists brands with a similar name (search them at /v1/public/brands?q=). A request that attaches payment up front is not checked and can still be billed for an empty answer, so send the unpaid request first or check the name at /v1/public/brands. A brand the catalog holds that has nothing for this request is still answered, with coverage.reason. A brand longer than 120 characters is a 400.
1Response
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.