{"uid":"cap_d5smFcTNVDXyo5DdslK0p","slug":"syntalic-availability-index-b2d4bd44","name":"Syntalic Availability Index","description":"Marketing/competitive analysis query - $0.01 per request","url":"https://api.syntalic.com/v1/marketing/availability-index?utm_source=zero.xyz","method":"POST","headers":{},"bodySchema":{"type":"object","$schema":"https://json-schema.org/draft/2020-12/schema","required":["input"],"properties":{"input":{"type":"object","required":["type","method"],"properties":{"type":{"type":"string","const":"http"},"method":{"enum":["GET","HEAD","DELETE"],"type":"string"},"headers":{"type":"object","additionalProperties":{"type":"string"}},"queryParams":{"type":"object","properties":{"brand":{"type":"string","example":"Apple","minLength":1,"description":"Brand name (e.g., Sony, Samsung, Nike)"},"country":{"enum":["us","ca"],"type":"string","default":"us","example":"us","description":"Country (us or ca)"},"category":{"type":"string","example":"electronics","minLength":1,"description":"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'."},"aggregate_by":{"enum":["seller","category_root"],"type":"string","default":"seller","description":"Dimension to group by: retail chain (default) or category root."}},"additionalProperties":false}},"additionalProperties":false},"output":{"type":"object","required":["type"],"properties":{"type":{"type":"string"},"example":{"type":"object"}}}}},"responseSchema":null,"example":null,"exampleRequest":null,"tags":["x402"],"displayCostAmount":"0.01","displayCostAsset":"USDC","priceDynamic":false,"priceHint":null,"priceStatus":"priced","priceSource":"registry","requiresHandshake":false,"reviewCount":0,"rating":{"score":"0.00","successRate":"0.00","reviews":0,"stars":null,"state":"unrated"},"availabilityStatus":"unknown","priceObserved":null,"sessionDeposit":null,"pricing":{"kind":"static","summary":"$0.01/call","primary":{"kind":"static","protocol":"x402","network":"base","amountUsd":"0.01","per":"call","confidence":"exact"},"accepted":[{"kind":"static","protocol":"x402","network":"base","amountUsd":"0.01","per":"call","confidence":"exact"}]},"paymentMethods":[{"uid":"pm__i3_ktx6YY41dLh0EG2qt","protocol":"x402","methodType":"crypto","chain":"base","mode":"charge","costAmount":"0.01","costPer":"request","priority":0,"asset":null,"unit":"request","depositMicros":null,"planRef":null}],"brandName":null,"brandSlug":null,"brandBaseUrl":null,"brandDocsUrl":null,"whatItDoes":"Returns a brand's product availability index across retail channels, aggregated by seller or category root, for competitive marketing analysis","exampleAgentPrompt":"What's Nike's availability index across US retailers in the footwear category, grouped by seller?","exampleUseCases":[{"title":"Brand shelf-presence benchmarking","prompt":"How available is Apple in the electronics category across US retailers right now? Group the results by seller so I can see which chains carry the most Apple products."},{"title":"CPG category share-of-shelf Canada","prompt":"Check the availability index for Dove in the beauty category in Canada and break it down by seller — I want to know where they have the strongest shelf presence."},{"title":"Category-root availability comparison","prompt":"For Samsung products in the US, can you pull the availability index grouped by category root so I can see which product types have the broadest retail coverage?"}],"resultDescription":"A normalized availability index for the specified brand and category, broken down by the chosen aggregation dimension (retail seller or category root), reflecting how broadly the brand's products appear across retailer shelves in the selected country.","failureModes":["Missing required 'brand' or 'category' query params — returns 400 bad request","Invalid country code (not 'us' or 'ca') — validation error","Brand not found in catalog — may return empty index or zero values","Unknown or unresolvable category string — no matching products found","Payment failure (x402) — request rejected before processing","Rate limiting or quota exceeded — 429 response"],"whenToPreferThis":"Use this endpoint when you need a quantitative measure of a brand's retail availability or share-of-shelf across sellers or category segments. It is distinct from price positioning (which compares price tiers) or promo intelligence (which tracks discounts) — this specifically indexes how widely a brand's products are stocked. Prefer it over the analyst-level or social signals endpoints when the user's question is about physical/digital retail presence and distribution breadth rather than pricing or sentiment.","instructions":null,"reviewSummary":null,"reviewSummaryHighlights":null,"reviewSummaryConcerns":null,"reviewSummaryGeneratedAt":null,"activationCount":0,"lastUsedAt":null,"lastSuccessfullyRanAt":null,"lastHealthCheckAt":"2026-10-27T19:17:48.742Z","isFirstParty":false,"canonicalSlug":"syntalic-availability-index-b2d4bd44"}