curl --request GET \
--url https://api.syntalic.com/v1/marketing/promo-intelligenceimport requests
url = "https://api.syntalic.com/v1/marketing/promo-intelligence"
response = requests.get(url)
print(response.text)const options = {method: 'GET'};
fetch('https://api.syntalic.com/v1/marketing/promo-intelligence', 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/marketing/promo-intelligence",
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/marketing/promo-intelligence"
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/marketing/promo-intelligence")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.syntalic.com/v1/marketing/promo-intelligence")
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/clothing/activewear",
"country": "us",
"currency": "USD",
"retailer": null,
"brand": null,
"aggregate_by": "brand",
"window": {
"preset": "last_30_days",
"from": "2026-10-20",
"to": "2026-11-19",
"granularity": "daily",
"timezone": "UTC"
},
"results": [
{
"name": "Gymshark",
"brand": "Gymshark",
"total_observations": 9211,
"promo_observations": 5686,
"listings": 5521,
"promo_listings": 5456,
"promo_frequency_pct": 61.7,
"avg_promo_depth_pct": 36.2,
"max_promo_depth_pct": 70
},
{
"name": "POPFLEX®",
"brand": "POPFLEX®",
"total_observations": 14016,
"promo_observations": 2651,
"listings": 4757,
"promo_listings": 894,
"promo_frequency_pct": 18.9,
"avg_promo_depth_pct": 28.5,
"max_promo_depth_pct": 61.3
}
],
"brands": [
{
"brand": "Gymshark",
"total_observations": 9211,
"promo_observations": 5686,
"listings": 5521,
"promo_listings": 5456,
"promo_frequency_pct": 61.7,
"avg_promo_depth_pct": 36.2,
"max_promo_depth_pct": 70
},
{
"brand": "POPFLEX®",
"total_observations": 14016,
"promo_observations": 2651,
"listings": 4757,
"promo_listings": 894,
"promo_frequency_pct": 18.9,
"avg_promo_depth_pct": 28.5,
"max_promo_depth_pct": 61.3
}
],
"coverage": {
"products": 73,
"sufficient": true,
"counted": "brands"
},
"freshness": {
"observedThrough": "2026-11-18T19:01:44.751Z",
"staleHours": 15.4
},
"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/clothing/activewear",
"match_source": "slug",
"match_confidence": 0.35,
"alternates": []
},
"meta": {
"served_from": "live",
"freshness_seconds": 55582,
"schema_version": "v3",
"computed_at": "2026-11-19T10:28:06.864Z",
"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": {}
}
}Analyze promotional activity in a category
Analyze promotional activity within a category - promo frequency, average and max discount depth - over a date range. Pivot the breakdown with aggregate_by: default brand ranks brands within the category; retailer ranks retailers across the whole category, or, with brand=<name>, on one brand (‘which retailers run the deepest promos on Brand X in Category Y’). brand is optional in both modes. Read the rows from results: one key whatever the pivot, each row naming its brand or retailer in name (the response echoes aggregate_by). brands: [...] / retailers: [...] carry the same rows under a key that follows the pivot, kept for existing callers.
curl --request GET \
--url https://api.syntalic.com/v1/marketing/promo-intelligenceimport requests
url = "https://api.syntalic.com/v1/marketing/promo-intelligence"
response = requests.get(url)
print(response.text)const options = {method: 'GET'};
fetch('https://api.syntalic.com/v1/marketing/promo-intelligence', 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/marketing/promo-intelligence",
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/marketing/promo-intelligence"
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/marketing/promo-intelligence")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.syntalic.com/v1/marketing/promo-intelligence")
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/clothing/activewear",
"country": "us",
"currency": "USD",
"retailer": null,
"brand": null,
"aggregate_by": "brand",
"window": {
"preset": "last_30_days",
"from": "2026-10-20",
"to": "2026-11-19",
"granularity": "daily",
"timezone": "UTC"
},
"results": [
{
"name": "Gymshark",
"brand": "Gymshark",
"total_observations": 9211,
"promo_observations": 5686,
"listings": 5521,
"promo_listings": 5456,
"promo_frequency_pct": 61.7,
"avg_promo_depth_pct": 36.2,
"max_promo_depth_pct": 70
},
{
"name": "POPFLEX®",
"brand": "POPFLEX®",
"total_observations": 14016,
"promo_observations": 2651,
"listings": 4757,
"promo_listings": 894,
"promo_frequency_pct": 18.9,
"avg_promo_depth_pct": 28.5,
"max_promo_depth_pct": 61.3
}
],
"brands": [
{
"brand": "Gymshark",
"total_observations": 9211,
"promo_observations": 5686,
"listings": 5521,
"promo_listings": 5456,
"promo_frequency_pct": 61.7,
"avg_promo_depth_pct": 36.2,
"max_promo_depth_pct": 70
},
{
"brand": "POPFLEX®",
"total_observations": 14016,
"promo_observations": 2651,
"listings": 4757,
"promo_listings": 894,
"promo_frequency_pct": 18.9,
"avg_promo_depth_pct": 28.5,
"max_promo_depth_pct": 61.3
}
],
"coverage": {
"products": 73,
"sufficient": true,
"counted": "brands"
},
"freshness": {
"observedThrough": "2026-11-18T19:01:44.751Z",
"staleHours": 15.4
},
"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/clothing/activewear",
"match_source": "slug",
"match_confidence": 0.35,
"alternates": []
},
"meta": {
"served_from": "live",
"freshness_seconds": 55582,
"schema_version": "v3",
"computed_at": "2026-11-19T10:28:06.864Z",
"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
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 brand filter, in both modes — limit aggregation to products of this brand (case-insensitive). With aggregate_by=retailer it answers 'which retailers promote Brand X'; without it, retailers are ranked across the whole category. 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.
1Historical window preset. Explicit from/to takes precedence and is reported as custom; time_window=custom requires both from and to. Date-only ranges use UTC calendar boundaries with inclusive from and exclusive to.
last_30_days, last_60_days, last_90_days, month_to_date, previous_month, month_over_month, quarter_to_date, custom Optional. 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}$Response
Promo intelligence