curl --request GET \
--url https://api.syntalic.com/v1/measures/scoutimport requests
url = "https://api.syntalic.com/v1/measures/scout"
response = requests.get(url)
print(response.text)const options = {method: 'GET'};
fetch('https://api.syntalic.com/v1/measures/scout', 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/scout",
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/scout"
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/scout")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.syntalic.com/v1/measures/scout")
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": "food-beverages-tobacco/beverages/soda",
"country": "us",
"currency": "USD",
"window_days": 30,
"platform": "all",
"organic_only": false,
"brands": [
{
"brand": "poppi",
"brand_key": "poppi",
"mentions": 17,
"attention_share_pct": 32.08,
"products": 35,
"shelf_share_pct": 10.42,
"gap_pct": 21.66,
"thin_base": false
},
{
"brand": "Pepsi",
"brand_key": "pepsi",
"mentions": 9,
"attention_share_pct": 16.98,
"products": 2,
"shelf_share_pct": 0.6,
"gap_pct": 16.38,
"thin_base": false
}
],
"corpus_mentions": 53,
"thin_corpus": "The whole category drew 53 mentions in this window, so one post moves a brand's share by about 1.9 points. These shares are arithmetic, not a market signal: report the ranking as indicative at best, d",
"unmatched": {
"social_brands_not_on_shelf": 1,
"shelf_brands_not_in_conversation": 46,
"note": "Joined on brand key, never on name. Unmatched rows are excluded from the ranking rather than fuzzy-matched, because a wrong join here mislabels a real brand as under-distributed."
},
"coverage": {
"social": {
"products": 8,
"sufficient": true
},
"social_counted": "brands",
"shelf": {
"products": 336,
"sufficient": true
},
"shelf_counted": "products"
},
"freshness": {
"social": {
"observedThrough": "2026-11-16T06:26:37.000Z",
"staleHours": 58.2
},
"shelf_hours": null
},
"snapshot": {
"run_id": "d62295dc-6bb4-4d49-bb56-62432658a10a",
"lens_version": "social-publish-0.7",
"computed_at": "2026-11-16T12:42:25.858Z"
},
"resolved": null,
"meta": {
"served_from": "live",
"freshness_seconds": 34103,
"schema_version": "v3",
"computed_at": "2026-11-18T16:36:17.326Z"
}
}{
"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": {}
}
}Social attention set against the shelf.
Social attention set against the shelf. 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=gap: brands ranked by share of conversation against share of shelf, answered by /v1/social/attention-vs-shelf. by=launch: new arrivals on a shelf against the conversation around their brand, answered by /v1/social/launch-buzz.
curl --request GET \
--url https://api.syntalic.com/v1/measures/scoutimport requests
url = "https://api.syntalic.com/v1/measures/scout"
response = requests.get(url)
print(response.text)const options = {method: 'GET'};
fetch('https://api.syntalic.com/v1/measures/scout', 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/scout",
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/scout"
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/scout")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.syntalic.com/v1/measures/scout")
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": "food-beverages-tobacco/beverages/soda",
"country": "us",
"currency": "USD",
"window_days": 30,
"platform": "all",
"organic_only": false,
"brands": [
{
"brand": "poppi",
"brand_key": "poppi",
"mentions": 17,
"attention_share_pct": 32.08,
"products": 35,
"shelf_share_pct": 10.42,
"gap_pct": 21.66,
"thin_base": false
},
{
"brand": "Pepsi",
"brand_key": "pepsi",
"mentions": 9,
"attention_share_pct": 16.98,
"products": 2,
"shelf_share_pct": 0.6,
"gap_pct": 16.38,
"thin_base": false
}
],
"corpus_mentions": 53,
"thin_corpus": "The whole category drew 53 mentions in this window, so one post moves a brand's share by about 1.9 points. These shares are arithmetic, not a market signal: report the ranking as indicative at best, d",
"unmatched": {
"social_brands_not_on_shelf": 1,
"shelf_brands_not_in_conversation": 46,
"note": "Joined on brand key, never on name. Unmatched rows are excluded from the ranking rather than fuzzy-matched, because a wrong join here mislabels a real brand as under-distributed."
},
"coverage": {
"social": {
"products": 8,
"sufficient": true
},
"social_counted": "brands",
"shelf": {
"products": 336,
"sufficient": true
},
"shelf_counted": "products"
},
"freshness": {
"social": {
"observedThrough": "2026-11-16T06:26:37.000Z",
"staleHours": 58.2
},
"shelf_hours": null
},
"snapshot": {
"run_id": "d62295dc-6bb4-4d49-bb56-62432658a10a",
"lens_version": "social-publish-0.7",
"computed_at": "2026-11-16T12:42:25.858Z"
},
"resolved": null,
"meta": {
"served_from": "live",
"freshness_seconds": 34103,
"schema_version": "v3",
"computed_at": "2026-11-18T16:36:17.326Z"
}
}{
"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.
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. The shelf side reads the same node, so both shares divide up one category. No wildcard: these answers are ranked comparisons.
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.