{"openapi":"3.1.0","info":{"title":"Roasan API","version":"1","description":"Shopify store intelligence: stores, products, apps, themes and their changes. Every data route takes a Bearer API key."},"components":{"securitySchemes":{"apiKey":{"type":"http","scheme":"bearer","description":"A Roasan API key, created at /account/api-keys."}},"schemas":{}},"paths":{"/v1/stores":{"get":{"operationId":"getStores","summary":"GET /v1/stores (stores)","tags":["stores"],"description":"GET /v1/stores (stores). Signed-in: send `Authorization: Bearer <API key>` (keys are created at /account/api-keys).","parameters":[{"schema":{"type":"string","minLength":1,"maxLength":100},"in":"query","name":"q","required":false},{"schema":{"type":"string","maxLength":2000},"in":"query","name":"app","required":false,"description":"Comma-separated list (20 distinct values at most); a store matches any of them (OR). Values are validated like a single value; duplicates and order are ignored."},{"schema":{"default":"any","type":"string","enum":["any","all"]},"in":"query","name":"appMatch","required":false},{"schema":{"type":"string","maxLength":2000},"in":"query","name":"themeName","required":false,"description":"Comma-separated list (20 distinct values at most); a store matches any of them (OR). Values are validated like a single value; duplicates and order are ignored."},{"schema":{"type":"string","maxLength":2000},"in":"query","name":"country","required":false,"description":"Comma-separated list (20 distinct values at most); a store matches any of them (OR). Values are validated like a single value; duplicates and order are ignored."},{"schema":{"type":"integer","minimum":0,"maximum":10000000},"in":"query","name":"productMin","required":false},{"schema":{"type":"integer","minimum":0,"maximum":10000000},"in":"query","name":"productMax","required":false},{"schema":{"type":"string","format":"date-time","pattern":"^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d:[0-5]\\d(?:\\.\\d+)?(?:Z))$"},"in":"query","name":"changedSince","required":false},{"schema":{"type":"string","format":"date-time","pattern":"^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d:[0-5]\\d(?:\\.\\d+)?(?:Z))$"},"in":"query","name":"addedSince","required":false},{"schema":{"type":"string","format":"date-time","pattern":"^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d:[0-5]\\d(?:\\.\\d+)?(?:Z))$"},"in":"query","name":"addedUntil","required":false},{"schema":{"type":"string","format":"date-time","pattern":"^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d:[0-5]\\d(?:\\.\\d+)?(?:Z))$"},"in":"query","name":"foundedSince","required":false},{"schema":{"type":"string","format":"date-time","pattern":"^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d:[0-5]\\d(?:\\.\\d+)?(?:Z))$"},"in":"query","name":"foundedUntil","required":false},{"schema":{"type":"string","maxLength":2000},"in":"query","name":"niche","required":false,"description":"Comma-separated niche slugs (20 at most): main categories, niches or niche groups; a store matches any of them (OR). A niche matches stores where it is at least 20% of the labelled products."},{"schema":{"type":"string","maxLength":2000},"in":"query","name":"tag","required":false,"description":"Comma-separated tag slugs (20 at most); a result must carry every listed tag (AND). Duplicates and order are ignored."},{"schema":{"type":"string","maxLength":2000},"in":"query","name":"currency","required":false,"description":"Comma-separated list (20 distinct values at most); a store matches any of them (OR). Values are validated like a single value; duplicates and order are ignored."},{"schema":{"type":"string","maxLength":2000},"in":"query","name":"locale","required":false,"description":"Comma-separated list (20 distinct values at most); a store matches any of them (OR). Values are validated like a single value; duplicates and order are ignored."},{"schema":{"type":"string","maxLength":2000},"in":"query","name":"tld","required":false,"description":"Comma-separated list (20 distinct values at most); a store matches any of them (OR). Values are validated like a single value; duplicates and order are ignored."},{"schema":{"type":"string","enum":["open","password_protected"]},"in":"query","name":"access","required":false},{"schema":{"type":"string","enum":["email","phone","any"]},"in":"query","name":"contact","required":false},{"schema":{"type":"string","minLength":1,"maxLength":100},"in":"query","name":"signals","required":false},{"schema":{"type":"integer","minimum":0,"maximum":2000000000},"in":"query","name":"visitsMin","required":false},{"schema":{"type":"integer","minimum":0,"maximum":2000000000},"in":"query","name":"visitsMax","required":false},{"schema":{"type":"integer","minimum":1,"maximum":10000},"in":"query","name":"visitsGrowthMin","required":false},{"schema":{"type":"string","maxLength":2000},"in":"query","name":"visitorCountry","required":false,"description":"Comma-separated list (20 distinct values at most); a store matches any of them (OR). Values are validated like a single value; duplicates and order are ignored."},{"schema":{"type":"string","maxLength":2000},"in":"query","name":"appExclude","required":false,"description":"Comma-separated list (20 distinct values at most); a store matches any of them (OR). Values are validated like a single value; duplicates and order are ignored."},{"schema":{"type":"string","maxLength":2000},"in":"query","name":"appCategory","required":false,"description":"Comma-separated list (20 distinct values at most); a store matches any of them (OR). Values are validated like a single value; duplicates and order are ignored."},{"schema":{"type":"string","maxLength":2000},"in":"query","name":"appCategoryExclude","required":false,"description":"Comma-separated list (20 distinct values at most); a store matches any of them (OR). Values are validated like a single value; duplicates and order are ignored."},{"schema":{"type":"string","maxLength":2000},"in":"query","name":"pixel","required":false,"description":"Comma-separated list (20 distinct values at most); a store matches any of them (OR). Values are validated like a single value; duplicates and order are ignored."},{"schema":{"type":"string","maxLength":2000},"in":"query","name":"pixelExclude","required":false,"description":"Comma-separated list (20 distinct values at most); a store matches any of them (OR). Values are validated like a single value; duplicates and order are ignored."},{"schema":{"type":"string","maxLength":2000},"in":"query","name":"social","required":false,"description":"Comma-separated list (20 distinct values at most); a store matches any of them (OR). Values are validated like a single value; duplicates and order are ignored."},{"schema":{"type":"string","enum":["true","false"]},"in":"query","name":"headless","required":false},{"schema":{"type":"string","enum":["true","false"]},"in":"query","name":"shopPayInstallments","required":false},{"schema":{"type":"integer","minimum":0,"maximum":32767},"in":"query","name":"newProductsMin","required":false},{"schema":{"type":"integer","minimum":0,"maximum":2000000000},"in":"query","name":"collectionMin","required":false},{"schema":{"type":"integer","minimum":0,"maximum":2000000000},"in":"query","name":"collectionMax","required":false},{"schema":{"type":"integer","minimum":0,"maximum":100},"in":"query","name":"discountMin","required":false},{"schema":{"type":"integer","minimum":0,"maximum":100},"in":"query","name":"discountMax","required":false},{"schema":{"type":"integer","minimum":0,"maximum":100},"in":"query","name":"soldOutMin","required":false},{"schema":{"type":"integer","minimum":0,"maximum":100},"in":"query","name":"soldOutMax","required":false},{"schema":{"type":"integer","minimum":0,"maximum":32767},"in":"query","name":"vendorMin","required":false},{"schema":{"type":"integer","minimum":0,"maximum":32767},"in":"query","name":"vendorMax","required":false},{"schema":{"type":"integer","minimum":0,"maximum":2000000000},"in":"query","name":"reviewMin","required":false},{"schema":{"default":"relevance","type":"string","enum":["relevance","new","founded","signals","traffic","growth","products","newProducts","reviews"]},"in":"query","name":"sort","required":false},{"schema":{"type":"string","minLength":1,"maxLength":512},"in":"query","name":"cursor","required":false},{"schema":{"default":20,"type":"integer","minimum":1,"maximum":50},"in":"query","name":"limit","required":false}],"responses":{"200":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"items":{"maxItems":50,"type":"array","items":{"type":"object","properties":{"handle":{"description":"Canonical myshopify handle. Absent when unknown (headless stores); primaryDomain is then always present and serves as the store reference.","type":"string","maxLength":77,"pattern":"^[a-z0-9](?:[a-z0-9-]{0,61}[a-z0-9])?\\.myshopify\\.com$"},"primaryDomain":{"type":"string","maxLength":253,"pattern":"^(?:[a-z0-9](?:[a-z0-9-]{0,61}[a-z0-9])?\\.)+[a-z](?:[a-z0-9-]{0,61}[a-z0-9])?$"},"status":{"type":"string","enum":["active","password_protected","unreachable","not_shopify_anymore"]},"isHeadless":{"type":"boolean"},"theme":{"type":"object","properties":{"id":{"type":"string","minLength":1},"name":{"type":"string","minLength":1}},"additionalProperties":false},"productCount":{"type":"integer","minimum":0,"maximum":9007199254740991},"currency":{"type":"string","pattern":"^[A-Z]{3}$"},"locale":{"type":"string","maxLength":35,"pattern":"^[a-z]{2,3}(?:-[A-Za-z0-9]{2,8})*$"},"countryHint":{"type":"string","pattern":"^[A-Z]{2}$"},"country":{"type":"string","pattern":"^[A-Z]{2}$"},"contact":{"type":"object","properties":{"kind":{"type":"string","enum":["non_personal","personal"]},"email":{"type":"string","format":"email","pattern":"^(?:[A-Za-z0-9_'+\\-]+\\.)*[A-Za-z0-9_'+\\-]*[A-Za-z0-9_+-]@(?:[A-Za-z0-9][A-Za-z0-9\\-]*\\.)+[A-Za-z]{2,}$"},"phone":{"type":"string","pattern":"^\\+[1-9][0-9]{7,14}$"}},"required":["kind"],"additionalProperties":false},"foundedAt":{"type":"string","format":"date-time","pattern":"^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d:[0-5]\\d(?:\\.\\d+)?(?:Z))$"},"foundedPrecision":{"type":"string","enum":["day","month"]},"firstSeenAt":{"type":"string","format":"date-time","pattern":"^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d:[0-5]\\d(?:\\.\\d+)?(?:Z))$"},"preview":{"oneOf":[{"type":"object","properties":{"kind":{"type":"string","enum":["mosaic"]},"tiles":{"minItems":1,"maxItems":4,"type":"array","items":{"type":"string","format":"uri"}}},"required":["kind","tiles"],"additionalProperties":false},{"type":"object","properties":{"kind":{"type":"string","enum":["screenshot"]},"url":{"type":"string","format":"uri"},"thumbUrl":{"type":"string","format":"uri"},"tiles":{"minItems":1,"maxItems":4,"type":"array","items":{"type":"string","format":"uri"}}},"required":["kind","url"],"additionalProperties":false}]},"traffic":{"description":"Estimated monthly visits (latest finished month). confidence none = under ~1K; low carries a range instead of a figure; null = not measured yet.","anyOf":[{"type":"object","properties":{"month":{"type":"string","pattern":"^\\d{4}-\\d{2}$"},"confidence":{"type":"string","enum":["high","medium","low","none"]},"visits":{"anyOf":[{"type":"integer","minimum":0,"maximum":9007199254740991},{"type":"null"}]},"range":{"anyOf":[{"type":"object","properties":{"low":{"type":"integer","minimum":0,"maximum":9007199254740991},"high":{"type":"integer","minimum":0,"maximum":9007199254740991}},"required":["low","high"],"additionalProperties":false},{"type":"null"}]}},"required":["month","confidence","visits","range"],"additionalProperties":false},{"type":"null"}]},"signals":{"type":"object","properties":{"postPurchaseApps":{"description":"Post-purchase apps other than reviews (shipment tracking, returns, order status)","type":"integer","minimum":0,"maximum":9007199254740991},"hasReviewApp":{"type":"boolean"},"reviewCount":{"description":"Review total visible on the homepage; absent when no widget shows a count","type":"integer","minimum":0,"maximum":9007199254740991},"productsAdded30d":{"type":"integer","minimum":0,"maximum":9007199254740991},"copiedByStores":{"description":"Other stores that added this store's products later","type":"integer","minimum":0,"maximum":9007199254740991},"firstSeenAt":{"type":"string","format":"date-time","pattern":"^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d:[0-5]\\d(?:\\.\\d+)?(?:Z))$","description":"When Roasan first saw the store; not its launch date"}},"required":["firstSeenAt"],"additionalProperties":false},"appCount":{"type":"integer","minimum":0,"maximum":9007199254740991},"appLogos":{"maxItems":3,"type":"array","items":{"type":"object","properties":{"name":{"type":"string","minLength":1},"iconUrl":{"type":"string","format":"uri"}},"required":["name","iconUrl"],"additionalProperties":false}},"productTiles":{"maxItems":3,"type":"array","items":{"type":"object","properties":{"imageUrl":{"type":"string","format":"uri"},"title":{"type":"string","maxLength":500},"price":{"type":"string","pattern":"^\\d{1,10}(\\.\\d{1,2})?$"}},"required":["imageUrl","title"],"additionalProperties":false}},"trafficSpark":{"maxItems":12,"type":"array","items":{"anyOf":[{"type":"integer","minimum":0,"maximum":9007199254740991},{"type":"null"}]}},"businessCountry":{"type":"string","pattern":"^[A-Z]{2}$"},"topCountries":{"maxItems":3,"type":"array","items":{"type":"string","pattern":"^[A-Z]{2}$"}}},"required":["status","isHeadless","firstSeenAt"],"additionalProperties":false}},"nextCursor":{"anyOf":[{"type":"string","minLength":1},{"type":"null"}]},"total":{"type":"integer","minimum":0,"maximum":10000},"totalCapped":{"type":"boolean"},"totalEstimate":{"type":"integer","minimum":0,"maximum":9007199254740991},"locked":{"type":"boolean","enum":[true]},"partial":{"type":"boolean","enum":[true]}},"required":["items","nextCursor","total","totalCapped"],"additionalProperties":false}}}},"400":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"code":{"anyOf":[{"type":"string","enum":["validation","unauthenticated","scope_missing","forbidden","plan_required","email_unverified","not_found","conflict","limit_exceeded","rate_limited","row_budget_exhausted","refine_filters","upstream"]},{"type":"string","enum":["internal","timeout"]}]},"message":{"type":"string"},"details":{"type":"object","propertyNames":{"type":"string"},"additionalProperties":{}}},"required":["code","message"],"additionalProperties":false}},"required":["error"],"additionalProperties":false}}}},"401":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"code":{"anyOf":[{"type":"string","enum":["validation","unauthenticated","scope_missing","forbidden","plan_required","email_unverified","not_found","conflict","limit_exceeded","rate_limited","row_budget_exhausted","refine_filters","upstream"]},{"type":"string","enum":["internal","timeout"]}]},"message":{"type":"string"},"details":{"type":"object","propertyNames":{"type":"string"},"additionalProperties":{}}},"required":["code","message"],"additionalProperties":false}},"required":["error"],"additionalProperties":false}}}},"403":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"code":{"anyOf":[{"type":"string","enum":["validation","unauthenticated","scope_missing","forbidden","plan_required","email_unverified","not_found","conflict","limit_exceeded","rate_limited","row_budget_exhausted","refine_filters","upstream"]},{"type":"string","enum":["internal","timeout"]}]},"message":{"type":"string"},"details":{"type":"object","propertyNames":{"type":"string"},"additionalProperties":{}}},"required":["code","message"],"additionalProperties":false}},"required":["error"],"additionalProperties":false}}}},"404":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"code":{"anyOf":[{"type":"string","enum":["validation","unauthenticated","scope_missing","forbidden","plan_required","email_unverified","not_found","conflict","limit_exceeded","rate_limited","row_budget_exhausted","refine_filters","upstream"]},{"type":"string","enum":["internal","timeout"]}]},"message":{"type":"string"},"details":{"type":"object","propertyNames":{"type":"string"},"additionalProperties":{}}},"required":["code","message"],"additionalProperties":false}},"required":["error"],"additionalProperties":false}}}},"429":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"code":{"anyOf":[{"type":"string","enum":["validation","unauthenticated","scope_missing","forbidden","plan_required","email_unverified","not_found","conflict","limit_exceeded","rate_limited","row_budget_exhausted","refine_filters","upstream"]},{"type":"string","enum":["internal","timeout"]}]},"message":{"type":"string"},"details":{"type":"object","propertyNames":{"type":"string"},"additionalProperties":{}}},"required":["code","message"],"additionalProperties":false}},"required":["error"],"additionalProperties":false}}}}}}},"/v1/stores/new":{"get":{"operationId":"getStoresNew","summary":"GET /v1/stores/new (stores)","tags":["stores"],"description":"GET /v1/stores/new (stores). Signed-in: send `Authorization: Bearer <API key>` (keys are created at /account/api-keys).","parameters":[{"schema":{"type":"string","format":"date-time","pattern":"^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d:[0-5]\\d(?:\\.\\d+)?(?:Z))$"},"in":"query","name":"since","required":false},{"schema":{"type":"string","pattern":"^[A-Z]{2}$"},"in":"query","name":"country","required":false},{"schema":{"type":"string","minLength":1,"maxLength":32},"in":"query","name":"source","required":false,"description":"Admin only; ignored for other callers."},{"schema":{"type":"string","minLength":1,"maxLength":512},"in":"query","name":"cursor","required":false},{"schema":{"default":20,"type":"integer","minimum":1,"maximum":50},"in":"query","name":"limit","required":false}],"responses":{"200":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"items":{"maxItems":50,"type":"array","items":{"type":"object","properties":{"handle":{"description":"Canonical myshopify handle. Absent when unknown (headless stores); primaryDomain is then always present and serves as the store reference.","type":"string","maxLength":77,"pattern":"^[a-z0-9](?:[a-z0-9-]{0,61}[a-z0-9])?\\.myshopify\\.com$"},"primaryDomain":{"type":"string","maxLength":253,"pattern":"^(?:[a-z0-9](?:[a-z0-9-]{0,61}[a-z0-9])?\\.)+[a-z](?:[a-z0-9-]{0,61}[a-z0-9])?$"},"countryHint":{"type":"string","pattern":"^[A-Z]{2}$"},"country":{"type":"string","pattern":"^[A-Z]{2}$"},"foundedAt":{"type":"string","format":"date-time","pattern":"^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d:[0-5]\\d(?:\\.\\d+)?(?:Z))$"},"foundedPrecision":{"type":"string","enum":["day","month"]},"firstSeenAt":{"type":"string","format":"date-time","pattern":"^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d:[0-5]\\d(?:\\.\\d+)?(?:Z))$"},"preview":{"oneOf":[{"type":"object","properties":{"kind":{"type":"string","enum":["mosaic"]},"tiles":{"minItems":1,"maxItems":4,"type":"array","items":{"type":"string","format":"uri"}}},"required":["kind","tiles"],"additionalProperties":false},{"type":"object","properties":{"kind":{"type":"string","enum":["screenshot"]},"url":{"type":"string","format":"uri"},"thumbUrl":{"type":"string","format":"uri"},"tiles":{"minItems":1,"maxItems":4,"type":"array","items":{"type":"string","format":"uri"}}},"required":["kind","url"],"additionalProperties":false}]}},"required":["firstSeenAt"],"additionalProperties":false}},"nextCursor":{"anyOf":[{"type":"string","minLength":1},{"type":"null"}]}},"required":["items","nextCursor"],"additionalProperties":false}}}},"400":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"code":{"anyOf":[{"type":"string","enum":["validation","unauthenticated","scope_missing","forbidden","plan_required","email_unverified","not_found","conflict","limit_exceeded","rate_limited","row_budget_exhausted","refine_filters","upstream"]},{"type":"string","enum":["internal","timeout"]}]},"message":{"type":"string"},"details":{"type":"object","propertyNames":{"type":"string"},"additionalProperties":{}}},"required":["code","message"],"additionalProperties":false}},"required":["error"],"additionalProperties":false}}}},"401":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"code":{"anyOf":[{"type":"string","enum":["validation","unauthenticated","scope_missing","forbidden","plan_required","email_unverified","not_found","conflict","limit_exceeded","rate_limited","row_budget_exhausted","refine_filters","upstream"]},{"type":"string","enum":["internal","timeout"]}]},"message":{"type":"string"},"details":{"type":"object","propertyNames":{"type":"string"},"additionalProperties":{}}},"required":["code","message"],"additionalProperties":false}},"required":["error"],"additionalProperties":false}}}},"403":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"code":{"anyOf":[{"type":"string","enum":["validation","unauthenticated","scope_missing","forbidden","plan_required","email_unverified","not_found","conflict","limit_exceeded","rate_limited","row_budget_exhausted","refine_filters","upstream"]},{"type":"string","enum":["internal","timeout"]}]},"message":{"type":"string"},"details":{"type":"object","propertyNames":{"type":"string"},"additionalProperties":{}}},"required":["code","message"],"additionalProperties":false}},"required":["error"],"additionalProperties":false}}}},"404":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"code":{"anyOf":[{"type":"string","enum":["validation","unauthenticated","scope_missing","forbidden","plan_required","email_unverified","not_found","conflict","limit_exceeded","rate_limited","row_budget_exhausted","refine_filters","upstream"]},{"type":"string","enum":["internal","timeout"]}]},"message":{"type":"string"},"details":{"type":"object","propertyNames":{"type":"string"},"additionalProperties":{}}},"required":["code","message"],"additionalProperties":false}},"required":["error"],"additionalProperties":false}}}},"429":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"code":{"anyOf":[{"type":"string","enum":["validation","unauthenticated","scope_missing","forbidden","plan_required","email_unverified","not_found","conflict","limit_exceeded","rate_limited","row_budget_exhausted","refine_filters","upstream"]},{"type":"string","enum":["internal","timeout"]}]},"message":{"type":"string"},"details":{"type":"object","propertyNames":{"type":"string"},"additionalProperties":{}}},"required":["code","message"],"additionalProperties":false}},"required":["error"],"additionalProperties":false}}}}}}},"/v1/stores/suggest":{"get":{"operationId":"getStoresSuggest","summary":"GET /v1/stores/suggest (stores)","tags":["stores"],"description":"GET /v1/stores/suggest (stores). Signed-in: send `Authorization: Bearer <API key>` (keys are created at /account/api-keys).","parameters":[{"schema":{"type":"string","minLength":2,"maxLength":100},"in":"query","name":"q","required":true}],"responses":{"200":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"data":{"maxItems":6,"type":"array","items":{"type":"object","properties":{"ref":{"type":"string","minLength":1},"handle":{"type":"string","maxLength":77,"pattern":"^[a-z0-9](?:[a-z0-9-]{0,61}[a-z0-9])?\\.myshopify\\.com$"},"primaryDomain":{"type":"string","maxLength":253,"pattern":"^(?:[a-z0-9](?:[a-z0-9-]{0,61}[a-z0-9])?\\.)+[a-z](?:[a-z0-9-]{0,61}[a-z0-9])?$"},"name":{"type":"string","minLength":1},"faviconUrl":{"type":"string","format":"uri"},"country":{"type":"string","pattern":"^[A-Z]{2}$"},"productCount":{"type":"integer","minimum":0,"maximum":9007199254740991},"preview":{"oneOf":[{"type":"object","properties":{"kind":{"type":"string","enum":["mosaic"]},"tiles":{"minItems":1,"maxItems":4,"type":"array","items":{"type":"string","format":"uri"}}},"required":["kind","tiles"],"additionalProperties":false},{"type":"object","properties":{"kind":{"type":"string","enum":["screenshot"]},"url":{"type":"string","format":"uri"},"thumbUrl":{"type":"string","format":"uri"},"tiles":{"minItems":1,"maxItems":4,"type":"array","items":{"type":"string","format":"uri"}}},"required":["kind","url"],"additionalProperties":false}]}},"required":["ref"],"additionalProperties":false}}},"required":["data"],"additionalProperties":false}}}},"400":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"code":{"anyOf":[{"type":"string","enum":["validation","unauthenticated","scope_missing","forbidden","plan_required","email_unverified","not_found","conflict","limit_exceeded","rate_limited","row_budget_exhausted","refine_filters","upstream"]},{"type":"string","enum":["internal","timeout"]}]},"message":{"type":"string"},"details":{"type":"object","propertyNames":{"type":"string"},"additionalProperties":{}}},"required":["code","message"],"additionalProperties":false}},"required":["error"],"additionalProperties":false}}}},"401":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"code":{"anyOf":[{"type":"string","enum":["validation","unauthenticated","scope_missing","forbidden","plan_required","email_unverified","not_found","conflict","limit_exceeded","rate_limited","row_budget_exhausted","refine_filters","upstream"]},{"type":"string","enum":["internal","timeout"]}]},"message":{"type":"string"},"details":{"type":"object","propertyNames":{"type":"string"},"additionalProperties":{}}},"required":["code","message"],"additionalProperties":false}},"required":["error"],"additionalProperties":false}}}},"403":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"code":{"anyOf":[{"type":"string","enum":["validation","unauthenticated","scope_missing","forbidden","plan_required","email_unverified","not_found","conflict","limit_exceeded","rate_limited","row_budget_exhausted","refine_filters","upstream"]},{"type":"string","enum":["internal","timeout"]}]},"message":{"type":"string"},"details":{"type":"object","propertyNames":{"type":"string"},"additionalProperties":{}}},"required":["code","message"],"additionalProperties":false}},"required":["error"],"additionalProperties":false}}}},"404":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"code":{"anyOf":[{"type":"string","enum":["validation","unauthenticated","scope_missing","forbidden","plan_required","email_unverified","not_found","conflict","limit_exceeded","rate_limited","row_budget_exhausted","refine_filters","upstream"]},{"type":"string","enum":["internal","timeout"]}]},"message":{"type":"string"},"details":{"type":"object","propertyNames":{"type":"string"},"additionalProperties":{}}},"required":["code","message"],"additionalProperties":false}},"required":["error"],"additionalProperties":false}}}},"429":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"code":{"anyOf":[{"type":"string","enum":["validation","unauthenticated","scope_missing","forbidden","plan_required","email_unverified","not_found","conflict","limit_exceeded","rate_limited","row_budget_exhausted","refine_filters","upstream"]},{"type":"string","enum":["internal","timeout"]}]},"message":{"type":"string"},"details":{"type":"object","propertyNames":{"type":"string"},"additionalProperties":{}}},"required":["code","message"],"additionalProperties":false}},"required":["error"],"additionalProperties":false}}}}}}},"/v1/stores/{ref}":{"get":{"operationId":"getStoresByRef","summary":"GET /v1/stores/{ref} (stores)","tags":["stores"],"description":"GET /v1/stores/{ref} (stores). Signed-in: send `Authorization: Bearer <API key>` (keys are created at /account/api-keys).","parameters":[{"schema":{"type":"string","minLength":1,"maxLength":253,"pattern":"^[A-Za-z0-9.-]+$"},"in":"path","name":"ref","required":true}],"responses":{"200":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"storeId":{"type":"string","maxLength":19,"pattern":"^[1-9][0-9]*$"},"handle":{"description":"Canonical myshopify handle. Absent when unknown (headless stores); primaryDomain is then always present and serves as the store reference.","type":"string","maxLength":77,"pattern":"^[a-z0-9](?:[a-z0-9-]{0,61}[a-z0-9])?\\.myshopify\\.com$"},"shopId":{"type":"string","maxLength":19,"pattern":"^[1-9][0-9]*$"},"primaryDomain":{"type":"string","maxLength":253,"pattern":"^(?:[a-z0-9](?:[a-z0-9-]{0,61}[a-z0-9])?\\.)+[a-z](?:[a-z0-9-]{0,61}[a-z0-9])?$"},"status":{"type":"string","enum":["active","password_protected","unreachable","not_shopify_anymore"]},"isHeadless":{"type":"boolean"},"theme":{"type":"object","properties":{"id":{"type":"string","minLength":1},"name":{"type":"string","minLength":1}},"additionalProperties":false},"productCount":{"type":"integer","minimum":0,"maximum":9007199254740991},"currency":{"type":"string","pattern":"^[A-Z]{3}$"},"locale":{"type":"string","maxLength":35,"pattern":"^[a-z]{2,3}(?:-[A-Za-z0-9]{2,8})*$"},"countryHint":{"type":"string","pattern":"^[A-Z]{2}$"},"country":{"type":"string","pattern":"^[A-Z]{2}$"},"contact":{"type":"object","properties":{"kind":{"type":"string","enum":["non_personal","personal"]},"email":{"type":"string","format":"email","pattern":"^(?:[A-Za-z0-9_'+\\-]+\\.)*[A-Za-z0-9_'+\\-]*[A-Za-z0-9_+-]@(?:[A-Za-z0-9][A-Za-z0-9\\-]*\\.)+[A-Za-z]{2,}$"},"phone":{"type":"string","pattern":"^\\+[1-9][0-9]{7,14}$"}},"required":["kind"],"additionalProperties":false},"isSoleProprietor":{"type":"boolean"},"foundedAt":{"type":"string","format":"date-time","pattern":"^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d:[0-5]\\d(?:\\.\\d+)?(?:Z))$"},"foundedPrecision":{"type":"string","enum":["day","month"]},"firstSeenAt":{"type":"string","format":"date-time","pattern":"^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d:[0-5]\\d(?:\\.\\d+)?(?:Z))$"},"preview":{"oneOf":[{"type":"object","properties":{"kind":{"type":"string","enum":["mosaic"]},"tiles":{"minItems":1,"maxItems":4,"type":"array","items":{"type":"string","format":"uri"}}},"required":["kind","tiles"],"additionalProperties":false},{"type":"object","properties":{"kind":{"type":"string","enum":["screenshot"]},"url":{"type":"string","format":"uri"},"thumbUrl":{"type":"string","format":"uri"},"tiles":{"minItems":1,"maxItems":4,"type":"array","items":{"type":"string","format":"uri"}}},"required":["kind","url"],"additionalProperties":false}]},"pixels":{"description":"Ad and analytics platforms the storefront reports to, by name (e.g. meta, tiktok, google_ads, ga4, gtm, pinterest, snapchat, x, reddit, microsoft_ads, klaviyo). Never an account id.","maxItems":32,"type":"array","items":{"type":"string","minLength":1,"maxLength":32}},"storeName":{"type":"string","minLength":1,"maxLength":255},"faviconUrl":{"type":"string","format":"uri"},"category":{"type":"string","minLength":1,"maxLength":64},"secondCategory":{"type":"string","minLength":1,"maxLength":64},"niche":{"type":"string","minLength":1,"maxLength":64},"secondNiche":{"type":"string","minLength":1,"maxLength":64},"tags":{"maxItems":64,"type":"array","items":{"type":"string","minLength":1,"maxLength":64}},"businessAddress":{"type":"object","properties":{"city":{"type":"string","minLength":1,"maxLength":255},"province":{"type":"string","minLength":1,"maxLength":255},"country":{"type":"string","pattern":"^[A-Z]{2}$"}},"additionalProperties":false},"socialPlatforms":{"maxItems":32,"type":"array","items":{"type":"string","minLength":1,"maxLength":32}},"shipsToCount":{"type":"integer","minimum":0,"maximum":9007199254740991},"shopPayInstallments":{"type":"boolean"},"signals":{"type":"object","properties":{"postPurchaseApps":{"description":"Post-purchase apps other than reviews (shipment tracking, returns, order status)","type":"integer","minimum":0,"maximum":9007199254740991},"hasReviewApp":{"type":"boolean"},"reviewCount":{"description":"Review total visible on the homepage; absent when no widget shows a count","type":"integer","minimum":0,"maximum":9007199254740991},"productsAdded30d":{"type":"integer","minimum":0,"maximum":9007199254740991},"copiedByStores":{"description":"Other stores that added this store's products later","type":"integer","minimum":0,"maximum":9007199254740991},"firstSeenAt":{"type":"string","format":"date-time","pattern":"^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d:[0-5]\\d(?:\\.\\d+)?(?:Z))$","description":"When Roasan first saw the store; not its launch date"}},"required":["firstSeenAt"],"additionalProperties":false},"catalog":{"type":"object","properties":{"discountedShare":{"type":"integer","minimum":0,"maximum":100},"soldOutShare":{"type":"integer","minimum":0,"maximum":100},"vendorCount":{"type":"integer","minimum":0,"maximum":9007199254740991},"newProductImages30d":{"type":"integer","minimum":0,"maximum":9007199254740991}},"additionalProperties":false},"traffic":{"description":"Estimated monthly visits (latest finished month). confidence none = under ~1K; low carries a range instead of a figure; null = not measured yet.","anyOf":[{"type":"object","properties":{"month":{"type":"string","pattern":"^\\d{4}-\\d{2}$"},"confidence":{"type":"string","enum":["high","medium","low","none"]},"visits":{"anyOf":[{"type":"integer","minimum":0,"maximum":9007199254740991},{"type":"null"}]},"range":{"anyOf":[{"type":"object","properties":{"low":{"type":"integer","minimum":0,"maximum":9007199254740991},"high":{"type":"integer","minimum":0,"maximum":9007199254740991}},"required":["low","high"],"additionalProperties":false},{"type":"null"}]}},"required":["month","confidence","visits","range"],"additionalProperties":false},{"type":"null"}]}},"required":["storeId","status","isHeadless","isSoleProprietor","firstSeenAt"],"additionalProperties":false}}}},"400":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"code":{"anyOf":[{"type":"string","enum":["validation","unauthenticated","scope_missing","forbidden","plan_required","email_unverified","not_found","conflict","limit_exceeded","rate_limited","row_budget_exhausted","refine_filters","upstream"]},{"type":"string","enum":["internal","timeout"]}]},"message":{"type":"string"},"details":{"type":"object","propertyNames":{"type":"string"},"additionalProperties":{}}},"required":["code","message"],"additionalProperties":false}},"required":["error"],"additionalProperties":false}}}},"401":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"code":{"anyOf":[{"type":"string","enum":["validation","unauthenticated","scope_missing","forbidden","plan_required","email_unverified","not_found","conflict","limit_exceeded","rate_limited","row_budget_exhausted","refine_filters","upstream"]},{"type":"string","enum":["internal","timeout"]}]},"message":{"type":"string"},"details":{"type":"object","propertyNames":{"type":"string"},"additionalProperties":{}}},"required":["code","message"],"additionalProperties":false}},"required":["error"],"additionalProperties":false}}}},"403":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"code":{"anyOf":[{"type":"string","enum":["validation","unauthenticated","scope_missing","forbidden","plan_required","email_unverified","not_found","conflict","limit_exceeded","rate_limited","row_budget_exhausted","refine_filters","upstream"]},{"type":"string","enum":["internal","timeout"]}]},"message":{"type":"string"},"details":{"type":"object","propertyNames":{"type":"string"},"additionalProperties":{}}},"required":["code","message"],"additionalProperties":false}},"required":["error"],"additionalProperties":false}}}},"404":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"code":{"anyOf":[{"type":"string","enum":["validation","unauthenticated","scope_missing","forbidden","plan_required","email_unverified","not_found","conflict","limit_exceeded","rate_limited","row_budget_exhausted","refine_filters","upstream"]},{"type":"string","enum":["internal","timeout"]}]},"message":{"type":"string"},"details":{"type":"object","propertyNames":{"type":"string"},"additionalProperties":{}}},"required":["code","message"],"additionalProperties":false}},"required":["error"],"additionalProperties":false}}}},"429":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"code":{"anyOf":[{"type":"string","enum":["validation","unauthenticated","scope_missing","forbidden","plan_required","email_unverified","not_found","conflict","limit_exceeded","rate_limited","row_budget_exhausted","refine_filters","upstream"]},{"type":"string","enum":["internal","timeout"]}]},"message":{"type":"string"},"details":{"type":"object","propertyNames":{"type":"string"},"additionalProperties":{}}},"required":["code","message"],"additionalProperties":false}},"required":["error"],"additionalProperties":false}}}}}}},"/v1/stores/{ref}/changes":{"get":{"operationId":"getStoresByRefChanges","summary":"GET /v1/stores/{ref}/changes (stores)","tags":["stores"],"description":"GET /v1/stores/{ref}/changes (stores). Signed-in: send `Authorization: Bearer <API key>` (keys are created at /account/api-keys).","parameters":[{"schema":{"type":"string","format":"date-time","pattern":"^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d:[0-5]\\d(?:\\.\\d+)?(?:Z))$"},"in":"query","name":"since","required":false},{"schema":{"type":"string","minLength":1,"maxLength":512},"in":"query","name":"cursor","required":false},{"schema":{"default":20,"type":"integer","minimum":1,"maximum":50},"in":"query","name":"limit","required":false},{"schema":{"type":"string","minLength":1,"maxLength":253,"pattern":"^[A-Za-z0-9.-]+$"},"in":"path","name":"ref","required":true}],"responses":{"200":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"items":{"maxItems":50,"type":"array","items":{"type":"object","properties":{"field":{"type":"string","minLength":1},"oldValue":{"$ref":"#/components/schemas/schema0"},"newValue":{"$ref":"#/components/schemas/schema1"},"observedAt":{"type":"string","format":"date-time","pattern":"^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d:[0-5]\\d(?:\\.\\d+)?(?:Z))$"},"subject":{"type":"string","minLength":1,"maxLength":255}},"required":["field","oldValue","newValue","observedAt"],"additionalProperties":false}},"nextCursor":{"anyOf":[{"type":"string","minLength":1},{"type":"null"}]}},"required":["items","nextCursor"],"additionalProperties":false}}}},"400":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"code":{"anyOf":[{"type":"string","enum":["validation","unauthenticated","scope_missing","forbidden","plan_required","email_unverified","not_found","conflict","limit_exceeded","rate_limited","row_budget_exhausted","refine_filters","upstream"]},{"type":"string","enum":["internal","timeout"]}]},"message":{"type":"string"},"details":{"type":"object","propertyNames":{"type":"string"},"additionalProperties":{}}},"required":["code","message"],"additionalProperties":false}},"required":["error"],"additionalProperties":false}}}},"401":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"code":{"anyOf":[{"type":"string","enum":["validation","unauthenticated","scope_missing","forbidden","plan_required","email_unverified","not_found","conflict","limit_exceeded","rate_limited","row_budget_exhausted","refine_filters","upstream"]},{"type":"string","enum":["internal","timeout"]}]},"message":{"type":"string"},"details":{"type":"object","propertyNames":{"type":"string"},"additionalProperties":{}}},"required":["code","message"],"additionalProperties":false}},"required":["error"],"additionalProperties":false}}}},"403":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"code":{"anyOf":[{"type":"string","enum":["validation","unauthenticated","scope_missing","forbidden","plan_required","email_unverified","not_found","conflict","limit_exceeded","rate_limited","row_budget_exhausted","refine_filters","upstream"]},{"type":"string","enum":["internal","timeout"]}]},"message":{"type":"string"},"details":{"type":"object","propertyNames":{"type":"string"},"additionalProperties":{}}},"required":["code","message"],"additionalProperties":false}},"required":["error"],"additionalProperties":false}}}},"404":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"code":{"anyOf":[{"type":"string","enum":["validation","unauthenticated","scope_missing","forbidden","plan_required","email_unverified","not_found","conflict","limit_exceeded","rate_limited","row_budget_exhausted","refine_filters","upstream"]},{"type":"string","enum":["internal","timeout"]}]},"message":{"type":"string"},"details":{"type":"object","propertyNames":{"type":"string"},"additionalProperties":{}}},"required":["code","message"],"additionalProperties":false}},"required":["error"],"additionalProperties":false}}}},"429":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"code":{"anyOf":[{"type":"string","enum":["validation","unauthenticated","scope_missing","forbidden","plan_required","email_unverified","not_found","conflict","limit_exceeded","rate_limited","row_budget_exhausted","refine_filters","upstream"]},{"type":"string","enum":["internal","timeout"]}]},"message":{"type":"string"},"details":{"type":"object","propertyNames":{"type":"string"},"additionalProperties":{}}},"required":["code","message"],"additionalProperties":false}},"required":["error"],"additionalProperties":false}}}}}}},"/v1/stores/{ref}/apps":{"get":{"operationId":"getStoresByRefApps","summary":"GET /v1/stores/{ref}/apps (stores)","tags":["stores"],"description":"GET /v1/stores/{ref}/apps (stores). Signed-in: send `Authorization: Bearer <API key>` (keys are created at /account/api-keys).","parameters":[{"schema":{"type":"string","minLength":1,"maxLength":253,"pattern":"^[A-Za-z0-9.-]+$"},"in":"path","name":"ref","required":true}],"responses":{"200":{"description":"Default Response","content":{"application/json":{"schema":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string","maxLength":19,"pattern":"^[1-9][0-9]*$"},"name":{"type":"string","minLength":1},"vendor":{"type":"string","minLength":1},"iconUrl":{"type":"string","format":"uri"},"categories":{"type":"array","items":{"type":"object","properties":{"slug":{"type":"string","minLength":1},"name":{"type":"string","minLength":1}},"required":["slug","name"],"additionalProperties":false}},"firstSeenAt":{"type":"string","format":"date-time","pattern":"^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d:[0-5]\\d(?:\\.\\d+)?(?:Z))$"}},"required":["id","categories","firstSeenAt"],"additionalProperties":false}}}}},"400":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"code":{"anyOf":[{"type":"string","enum":["validation","unauthenticated","scope_missing","forbidden","plan_required","email_unverified","not_found","conflict","limit_exceeded","rate_limited","row_budget_exhausted","refine_filters","upstream"]},{"type":"string","enum":["internal","timeout"]}]},"message":{"type":"string"},"details":{"type":"object","propertyNames":{"type":"string"},"additionalProperties":{}}},"required":["code","message"],"additionalProperties":false}},"required":["error"],"additionalProperties":false}}}},"401":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"code":{"anyOf":[{"type":"string","enum":["validation","unauthenticated","scope_missing","forbidden","plan_required","email_unverified","not_found","conflict","limit_exceeded","rate_limited","row_budget_exhausted","refine_filters","upstream"]},{"type":"string","enum":["internal","timeout"]}]},"message":{"type":"string"},"details":{"type":"object","propertyNames":{"type":"string"},"additionalProperties":{}}},"required":["code","message"],"additionalProperties":false}},"required":["error"],"additionalProperties":false}}}},"403":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"code":{"anyOf":[{"type":"string","enum":["validation","unauthenticated","scope_missing","forbidden","plan_required","email_unverified","not_found","conflict","limit_exceeded","rate_limited","row_budget_exhausted","refine_filters","upstream"]},{"type":"string","enum":["internal","timeout"]}]},"message":{"type":"string"},"details":{"type":"object","propertyNames":{"type":"string"},"additionalProperties":{}}},"required":["code","message"],"additionalProperties":false}},"required":["error"],"additionalProperties":false}}}},"404":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"code":{"anyOf":[{"type":"string","enum":["validation","unauthenticated","scope_missing","forbidden","plan_required","email_unverified","not_found","conflict","limit_exceeded","rate_limited","row_budget_exhausted","refine_filters","upstream"]},{"type":"string","enum":["internal","timeout"]}]},"message":{"type":"string"},"details":{"type":"object","propertyNames":{"type":"string"},"additionalProperties":{}}},"required":["code","message"],"additionalProperties":false}},"required":["error"],"additionalProperties":false}}}},"429":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"code":{"anyOf":[{"type":"string","enum":["validation","unauthenticated","scope_missing","forbidden","plan_required","email_unverified","not_found","conflict","limit_exceeded","rate_limited","row_budget_exhausted","refine_filters","upstream"]},{"type":"string","enum":["internal","timeout"]}]},"message":{"type":"string"},"details":{"type":"object","propertyNames":{"type":"string"},"additionalProperties":{}}},"required":["code","message"],"additionalProperties":false}},"required":["error"],"additionalProperties":false}}}}}}},"/v1/stores/{ref}/similar":{"get":{"operationId":"getStoresByRefSimilar","summary":"GET /v1/stores/{ref}/similar (stores)","tags":["stores"],"description":"GET /v1/stores/{ref}/similar (stores). Signed-in: send `Authorization: Bearer <API key>` (keys are created at /account/api-keys).","parameters":[{"schema":{"type":"string","minLength":1,"maxLength":253,"pattern":"^[A-Za-z0-9.-]+$"},"in":"path","name":"ref","required":true}],"responses":{"200":{"description":"Default Response","content":{"application/json":{"schema":{"maxItems":5,"type":"array","items":{"type":"object","properties":{"handle":{"type":"string","maxLength":77,"pattern":"^[a-z0-9](?:[a-z0-9-]{0,61}[a-z0-9])?\\.myshopify\\.com$"},"primaryDomain":{"type":"string","maxLength":253,"pattern":"^(?:[a-z0-9](?:[a-z0-9-]{0,61}[a-z0-9])?\\.)+[a-z](?:[a-z0-9-]{0,61}[a-z0-9])?$"},"storeName":{"type":"string","minLength":1,"maxLength":255},"faviconUrl":{"type":"string","format":"uri"},"category":{"type":"string","minLength":1,"maxLength":64},"countryHint":{"type":"string","pattern":"^[A-Z]{2}$"},"country":{"type":"string","pattern":"^[A-Z]{2}$"},"productCount":{"type":"integer","minimum":0,"maximum":9007199254740991},"foundedAt":{"type":"string","format":"date-time","pattern":"^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d:[0-5]\\d(?:\\.\\d+)?(?:Z))$"},"preview":{"oneOf":[{"type":"object","properties":{"kind":{"type":"string","enum":["mosaic"]},"tiles":{"minItems":1,"maxItems":4,"type":"array","items":{"type":"string","format":"uri"}}},"required":["kind","tiles"],"additionalProperties":false},{"type":"object","properties":{"kind":{"type":"string","enum":["screenshot"]},"url":{"type":"string","format":"uri"},"thumbUrl":{"type":"string","format":"uri"},"tiles":{"minItems":1,"maxItems":4,"type":"array","items":{"type":"string","format":"uri"}}},"required":["kind","url"],"additionalProperties":false}]},"reason":{"type":"string","enum":["shared_products","same_niche_country","same_price_band","same_niche"]},"sharedProducts":{"type":"integer","minimum":0,"maximum":9007199254740991}},"required":["reason","sharedProducts"],"additionalProperties":false}}}}},"400":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"code":{"anyOf":[{"type":"string","enum":["validation","unauthenticated","scope_missing","forbidden","plan_required","email_unverified","not_found","conflict","limit_exceeded","rate_limited","row_budget_exhausted","refine_filters","upstream"]},{"type":"string","enum":["internal","timeout"]}]},"message":{"type":"string"},"details":{"type":"object","propertyNames":{"type":"string"},"additionalProperties":{}}},"required":["code","message"],"additionalProperties":false}},"required":["error"],"additionalProperties":false}}}},"401":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"code":{"anyOf":[{"type":"string","enum":["validation","unauthenticated","scope_missing","forbidden","plan_required","email_unverified","not_found","conflict","limit_exceeded","rate_limited","row_budget_exhausted","refine_filters","upstream"]},{"type":"string","enum":["internal","timeout"]}]},"message":{"type":"string"},"details":{"type":"object","propertyNames":{"type":"string"},"additionalProperties":{}}},"required":["code","message"],"additionalProperties":false}},"required":["error"],"additionalProperties":false}}}},"403":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"code":{"anyOf":[{"type":"string","enum":["validation","unauthenticated","scope_missing","forbidden","plan_required","email_unverified","not_found","conflict","limit_exceeded","rate_limited","row_budget_exhausted","refine_filters","upstream"]},{"type":"string","enum":["internal","timeout"]}]},"message":{"type":"string"},"details":{"type":"object","propertyNames":{"type":"string"},"additionalProperties":{}}},"required":["code","message"],"additionalProperties":false}},"required":["error"],"additionalProperties":false}}}},"404":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"code":{"anyOf":[{"type":"string","enum":["validation","unauthenticated","scope_missing","forbidden","plan_required","email_unverified","not_found","conflict","limit_exceeded","rate_limited","row_budget_exhausted","refine_filters","upstream"]},{"type":"string","enum":["internal","timeout"]}]},"message":{"type":"string"},"details":{"type":"object","propertyNames":{"type":"string"},"additionalProperties":{}}},"required":["code","message"],"additionalProperties":false}},"required":["error"],"additionalProperties":false}}}},"429":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"code":{"anyOf":[{"type":"string","enum":["validation","unauthenticated","scope_missing","forbidden","plan_required","email_unverified","not_found","conflict","limit_exceeded","rate_limited","row_budget_exhausted","refine_filters","upstream"]},{"type":"string","enum":["internal","timeout"]}]},"message":{"type":"string"},"details":{"type":"object","propertyNames":{"type":"string"},"additionalProperties":{}}},"required":["code","message"],"additionalProperties":false}},"required":["error"],"additionalProperties":false}}}}}}},"/v1/traffic/status":{"get":{"operationId":"getTrafficStatus","summary":"GET /v1/traffic/status (stores)","tags":["stores"],"description":"GET /v1/traffic/status (stores). Signed-in: send `Authorization: Bearer <API key>` (keys are created at /account/api-keys).","responses":{"200":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"month":{"anyOf":[{"type":"string","pattern":"^\\d{4}-\\d{2}$"},{"type":"null"}]}},"required":["month"],"additionalProperties":false}}}},"400":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"code":{"anyOf":[{"type":"string","enum":["validation","unauthenticated","scope_missing","forbidden","plan_required","email_unverified","not_found","conflict","limit_exceeded","rate_limited","row_budget_exhausted","refine_filters","upstream"]},{"type":"string","enum":["internal","timeout"]}]},"message":{"type":"string"},"details":{"type":"object","propertyNames":{"type":"string"},"additionalProperties":{}}},"required":["code","message"],"additionalProperties":false}},"required":["error"],"additionalProperties":false}}}},"401":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"code":{"anyOf":[{"type":"string","enum":["validation","unauthenticated","scope_missing","forbidden","plan_required","email_unverified","not_found","conflict","limit_exceeded","rate_limited","row_budget_exhausted","refine_filters","upstream"]},{"type":"string","enum":["internal","timeout"]}]},"message":{"type":"string"},"details":{"type":"object","propertyNames":{"type":"string"},"additionalProperties":{}}},"required":["code","message"],"additionalProperties":false}},"required":["error"],"additionalProperties":false}}}},"403":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"code":{"anyOf":[{"type":"string","enum":["validation","unauthenticated","scope_missing","forbidden","plan_required","email_unverified","not_found","conflict","limit_exceeded","rate_limited","row_budget_exhausted","refine_filters","upstream"]},{"type":"string","enum":["internal","timeout"]}]},"message":{"type":"string"},"details":{"type":"object","propertyNames":{"type":"string"},"additionalProperties":{}}},"required":["code","message"],"additionalProperties":false}},"required":["error"],"additionalProperties":false}}}},"404":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"code":{"anyOf":[{"type":"string","enum":["validation","unauthenticated","scope_missing","forbidden","plan_required","email_unverified","not_found","conflict","limit_exceeded","rate_limited","row_budget_exhausted","refine_filters","upstream"]},{"type":"string","enum":["internal","timeout"]}]},"message":{"type":"string"},"details":{"type":"object","propertyNames":{"type":"string"},"additionalProperties":{}}},"required":["code","message"],"additionalProperties":false}},"required":["error"],"additionalProperties":false}}}},"429":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"code":{"anyOf":[{"type":"string","enum":["validation","unauthenticated","scope_missing","forbidden","plan_required","email_unverified","not_found","conflict","limit_exceeded","rate_limited","row_budget_exhausted","refine_filters","upstream"]},{"type":"string","enum":["internal","timeout"]}]},"message":{"type":"string"},"details":{"type":"object","propertyNames":{"type":"string"},"additionalProperties":{}}},"required":["code","message"],"additionalProperties":false}},"required":["error"],"additionalProperties":false}}}}}}},"/v1/stores/{ref}/traffic":{"get":{"operationId":"getStoresByRefTraffic","summary":"GET /v1/stores/{ref}/traffic (stores)","tags":["stores"],"description":"GET /v1/stores/{ref}/traffic (stores). Signed-in: send `Authorization: Bearer <API key>` (keys are created at /account/api-keys).","parameters":[{"schema":{"type":"string","minLength":1,"maxLength":253,"pattern":"^[A-Za-z0-9.-]+$"},"in":"path","name":"ref","required":true}],"responses":{"200":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"month":{"anyOf":[{"type":"string","pattern":"^\\d{4}-\\d{2}$"},{"type":"null"}]},"traffic":{"anyOf":[{"type":"object","properties":{"month":{"type":"string","pattern":"^\\d{4}-\\d{2}$"},"confidence":{"type":"string","enum":["high","medium","low","none"]},"visits":{"anyOf":[{"type":"integer","minimum":0,"maximum":9007199254740991},{"type":"null"}]},"range":{"anyOf":[{"type":"object","properties":{"low":{"type":"integer","minimum":0,"maximum":9007199254740991},"high":{"type":"integer","minimum":0,"maximum":9007199254740991}},"required":["low","high"],"additionalProperties":false},{"type":"null"}]}},"required":["month","confidence","visits","range"],"additionalProperties":false},{"type":"null"}]},"series":{"maxItems":12,"type":"array","items":{"type":"object","properties":{"month":{"type":"string","pattern":"^\\d{4}-\\d{2}$"},"visits":{"anyOf":[{"type":"integer","minimum":0,"maximum":9007199254740991},{"type":"null"}]},"confidence":{"type":"string","enum":["high","medium","low","none"]}},"required":["month","visits","confidence"],"additionalProperties":false}},"countries":{"maxItems":5,"type":"array","items":{"type":"object","properties":{"country":{"type":"string","pattern":"^[A-Z]{2}$"},"bucket":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991}},"required":["country","bucket"],"additionalProperties":false}}},"required":["month","traffic","series","countries"],"additionalProperties":false}}}},"400":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"code":{"anyOf":[{"type":"string","enum":["validation","unauthenticated","scope_missing","forbidden","plan_required","email_unverified","not_found","conflict","limit_exceeded","rate_limited","row_budget_exhausted","refine_filters","upstream"]},{"type":"string","enum":["internal","timeout"]}]},"message":{"type":"string"},"details":{"type":"object","propertyNames":{"type":"string"},"additionalProperties":{}}},"required":["code","message"],"additionalProperties":false}},"required":["error"],"additionalProperties":false}}}},"401":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"code":{"anyOf":[{"type":"string","enum":["validation","unauthenticated","scope_missing","forbidden","plan_required","email_unverified","not_found","conflict","limit_exceeded","rate_limited","row_budget_exhausted","refine_filters","upstream"]},{"type":"string","enum":["internal","timeout"]}]},"message":{"type":"string"},"details":{"type":"object","propertyNames":{"type":"string"},"additionalProperties":{}}},"required":["code","message"],"additionalProperties":false}},"required":["error"],"additionalProperties":false}}}},"403":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"code":{"anyOf":[{"type":"string","enum":["validation","unauthenticated","scope_missing","forbidden","plan_required","email_unverified","not_found","conflict","limit_exceeded","rate_limited","row_budget_exhausted","refine_filters","upstream"]},{"type":"string","enum":["internal","timeout"]}]},"message":{"type":"string"},"details":{"type":"object","propertyNames":{"type":"string"},"additionalProperties":{}}},"required":["code","message"],"additionalProperties":false}},"required":["error"],"additionalProperties":false}}}},"404":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"code":{"anyOf":[{"type":"string","enum":["validation","unauthenticated","scope_missing","forbidden","plan_required","email_unverified","not_found","conflict","limit_exceeded","rate_limited","row_budget_exhausted","refine_filters","upstream"]},{"type":"string","enum":["internal","timeout"]}]},"message":{"type":"string"},"details":{"type":"object","propertyNames":{"type":"string"},"additionalProperties":{}}},"required":["code","message"],"additionalProperties":false}},"required":["error"],"additionalProperties":false}}}},"429":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"code":{"anyOf":[{"type":"string","enum":["validation","unauthenticated","scope_missing","forbidden","plan_required","email_unverified","not_found","conflict","limit_exceeded","rate_limited","row_budget_exhausted","refine_filters","upstream"]},{"type":"string","enum":["internal","timeout"]}]},"message":{"type":"string"},"details":{"type":"object","propertyNames":{"type":"string"},"additionalProperties":{}}},"required":["code","message"],"additionalProperties":false}},"required":["error"],"additionalProperties":false}}}}}}},"/v1/stores/{ref}/catalog-series":{"get":{"operationId":"getStoresByRefCatalogSeries","summary":"GET /v1/stores/{ref}/catalog-series (stores)","tags":["stores"],"description":"GET /v1/stores/{ref}/catalog-series (stores). Signed-in: send `Authorization: Bearer <API key>` (keys are created at /account/api-keys).","parameters":[{"schema":{"default":"6m","type":"string","enum":["30d","6m","1y"]},"in":"query","name":"range","required":false},{"schema":{"type":"string","minLength":1,"maxLength":253,"pattern":"^[A-Za-z0-9.-]+$"},"in":"path","name":"ref","required":true}],"responses":{"200":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"range":{"type":"string","enum":["30d","6m","1y"]},"since":{"type":"string","format":"date","pattern":"^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))$"},"points":{"type":"array","items":{"type":"object","properties":{"day":{"type":"string","format":"date","pattern":"^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))$"},"productCount":{"type":"integer","minimum":0,"maximum":9007199254740991}},"required":["day","productCount"],"additionalProperties":false}}},"required":["range","since","points"],"additionalProperties":false}}}},"400":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"code":{"anyOf":[{"type":"string","enum":["validation","unauthenticated","scope_missing","forbidden","plan_required","email_unverified","not_found","conflict","limit_exceeded","rate_limited","row_budget_exhausted","refine_filters","upstream"]},{"type":"string","enum":["internal","timeout"]}]},"message":{"type":"string"},"details":{"type":"object","propertyNames":{"type":"string"},"additionalProperties":{}}},"required":["code","message"],"additionalProperties":false}},"required":["error"],"additionalProperties":false}}}},"401":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"code":{"anyOf":[{"type":"string","enum":["validation","unauthenticated","scope_missing","forbidden","plan_required","email_unverified","not_found","conflict","limit_exceeded","rate_limited","row_budget_exhausted","refine_filters","upstream"]},{"type":"string","enum":["internal","timeout"]}]},"message":{"type":"string"},"details":{"type":"object","propertyNames":{"type":"string"},"additionalProperties":{}}},"required":["code","message"],"additionalProperties":false}},"required":["error"],"additionalProperties":false}}}},"403":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"code":{"anyOf":[{"type":"string","enum":["validation","unauthenticated","scope_missing","forbidden","plan_required","email_unverified","not_found","conflict","limit_exceeded","rate_limited","row_budget_exhausted","refine_filters","upstream"]},{"type":"string","enum":["internal","timeout"]}]},"message":{"type":"string"},"details":{"type":"object","propertyNames":{"type":"string"},"additionalProperties":{}}},"required":["code","message"],"additionalProperties":false}},"required":["error"],"additionalProperties":false}}}},"404":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"code":{"anyOf":[{"type":"string","enum":["validation","unauthenticated","scope_missing","forbidden","plan_required","email_unverified","not_found","conflict","limit_exceeded","rate_limited","row_budget_exhausted","refine_filters","upstream"]},{"type":"string","enum":["internal","timeout"]}]},"message":{"type":"string"},"details":{"type":"object","propertyNames":{"type":"string"},"additionalProperties":{}}},"required":["code","message"],"additionalProperties":false}},"required":["error"],"additionalProperties":false}}}},"429":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"code":{"anyOf":[{"type":"string","enum":["validation","unauthenticated","scope_missing","forbidden","plan_required","email_unverified","not_found","conflict","limit_exceeded","rate_limited","row_budget_exhausted","refine_filters","upstream"]},{"type":"string","enum":["internal","timeout"]}]},"message":{"type":"string"},"details":{"type":"object","propertyNames":{"type":"string"},"additionalProperties":{}}},"required":["code","message"],"additionalProperties":false}},"required":["error"],"additionalProperties":false}}}}}}},"/v1/collections":{"get":{"operationId":"getCollections","summary":"GET /v1/collections (collections)","tags":["collections"],"description":"GET /v1/collections (collections). Signed-in: send `Authorization: Bearer <API key>` (keys are created at /account/api-keys).","responses":{"200":{"description":"Default Response","content":{"application/json":{"schema":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"},"name":{"type":"string","minLength":1},"storeCount":{"type":"integer","minimum":0,"maximum":9007199254740991},"createdAt":{"type":"string","format":"date-time","pattern":"^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d:[0-5]\\d(?:\\.\\d+)?(?:Z))$"},"lastAddedAt":{"type":"string","format":"date-time","pattern":"^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d:[0-5]\\d(?:\\.\\d+)?(?:Z))$"},"previewStores":{"maxItems":3,"type":"array","items":{"type":"object","properties":{"storeId":{"type":"string","maxLength":19,"pattern":"^[1-9][0-9]*$"},"handle":{"type":"string","minLength":1},"primaryDomain":{"type":"string","minLength":1}},"required":["storeId"],"additionalProperties":false}},"topApps":{"maxItems":3,"type":"array","items":{"type":"object","properties":{"appClientId":{"type":"string","maxLength":19,"pattern":"^[1-9][0-9]*$"},"name":{"type":"string","minLength":1},"iconUrl":{"type":"string","format":"uri"},"storeCount":{"type":"integer","exclusiveMinimum":0,"maximum":9007199254740991}},"required":["appClientId","storeCount"],"additionalProperties":false}}},"required":["id","name","storeCount","createdAt","previewStores","topApps"],"additionalProperties":false}}}}},"400":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"code":{"anyOf":[{"type":"string","enum":["validation","unauthenticated","scope_missing","forbidden","plan_required","email_unverified","not_found","conflict","limit_exceeded","rate_limited","row_budget_exhausted","refine_filters","upstream"]},{"type":"string","enum":["internal","timeout"]}]},"message":{"type":"string"},"details":{"type":"object","propertyNames":{"type":"string"},"additionalProperties":{}}},"required":["code","message"],"additionalProperties":false}},"required":["error"],"additionalProperties":false}}}},"401":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"code":{"anyOf":[{"type":"string","enum":["validation","unauthenticated","scope_missing","forbidden","plan_required","email_unverified","not_found","conflict","limit_exceeded","rate_limited","row_budget_exhausted","refine_filters","upstream"]},{"type":"string","enum":["internal","timeout"]}]},"message":{"type":"string"},"details":{"type":"object","propertyNames":{"type":"string"},"additionalProperties":{}}},"required":["code","message"],"additionalProperties":false}},"required":["error"],"additionalProperties":false}}}}}},"post":{"operationId":"postCollections","summary":"POST /v1/collections (collections)","tags":["collections"],"description":"POST /v1/collections (collections). Signed-in: send `Authorization: Bearer <API key>` (keys are created at /account/api-keys).","requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"name":{"type":"string","minLength":1,"maxLength":100}},"required":["name"],"additionalProperties":false}}}},"responses":{"201":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"id":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"},"name":{"type":"string","minLength":1},"storeCount":{"type":"integer","minimum":0,"maximum":9007199254740991},"createdAt":{"type":"string","format":"date-time","pattern":"^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d:[0-5]\\d(?:\\.\\d+)?(?:Z))$"}},"required":["id","name","storeCount","createdAt"],"additionalProperties":false}}}},"400":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"code":{"anyOf":[{"type":"string","enum":["validation","unauthenticated","scope_missing","forbidden","plan_required","email_unverified","not_found","conflict","limit_exceeded","rate_limited","row_budget_exhausted","refine_filters","upstream"]},{"type":"string","enum":["internal","timeout"]}]},"message":{"type":"string"},"details":{"type":"object","propertyNames":{"type":"string"},"additionalProperties":{}}},"required":["code","message"],"additionalProperties":false}},"required":["error"],"additionalProperties":false}}}},"401":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"code":{"anyOf":[{"type":"string","enum":["validation","unauthenticated","scope_missing","forbidden","plan_required","email_unverified","not_found","conflict","limit_exceeded","rate_limited","row_budget_exhausted","refine_filters","upstream"]},{"type":"string","enum":["internal","timeout"]}]},"message":{"type":"string"},"details":{"type":"object","propertyNames":{"type":"string"},"additionalProperties":{}}},"required":["code","message"],"additionalProperties":false}},"required":["error"],"additionalProperties":false}}}},"409":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"code":{"anyOf":[{"type":"string","enum":["validation","unauthenticated","scope_missing","forbidden","plan_required","email_unverified","not_found","conflict","limit_exceeded","rate_limited","row_budget_exhausted","refine_filters","upstream"]},{"type":"string","enum":["internal","timeout"]}]},"message":{"type":"string"},"details":{"type":"object","propertyNames":{"type":"string"},"additionalProperties":{}}},"required":["code","message"],"additionalProperties":false}},"required":["error"],"additionalProperties":false}}}},"429":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"code":{"anyOf":[{"type":"string","enum":["validation","unauthenticated","scope_missing","forbidden","plan_required","email_unverified","not_found","conflict","limit_exceeded","rate_limited","row_budget_exhausted","refine_filters","upstream"]},{"type":"string","enum":["internal","timeout"]}]},"message":{"type":"string"},"details":{"type":"object","propertyNames":{"type":"string"},"additionalProperties":{}}},"required":["code","message"],"additionalProperties":false}},"required":["error"],"additionalProperties":false}}}}}}},"/v1/collections/{id}":{"get":{"operationId":"getCollectionsById","summary":"GET /v1/collections/{id} (collections)","tags":["collections"],"description":"GET /v1/collections/{id} (collections). Signed-in: send `Authorization: Bearer <API key>` (keys are created at /account/api-keys).","parameters":[{"schema":{"type":"string","minLength":1,"maxLength":512},"in":"query","name":"cursor","required":false},{"schema":{"default":20,"type":"integer","minimum":1,"maximum":50},"in":"query","name":"limit","required":false},{"schema":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"},"in":"path","name":"id","required":true}],"responses":{"200":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"items":{"maxItems":50,"type":"array","items":{"type":"object","properties":{"handle":{"description":"Canonical myshopify handle. Absent when unknown (headless stores); primaryDomain is then always present and serves as the store reference.","type":"string","maxLength":77,"pattern":"^[a-z0-9](?:[a-z0-9-]{0,61}[a-z0-9])?\\.myshopify\\.com$"},"primaryDomain":{"type":"string","maxLength":253,"pattern":"^(?:[a-z0-9](?:[a-z0-9-]{0,61}[a-z0-9])?\\.)+[a-z](?:[a-z0-9-]{0,61}[a-z0-9])?$"},"status":{"type":"string","enum":["active","password_protected","unreachable","not_shopify_anymore"]},"isHeadless":{"type":"boolean"},"theme":{"type":"object","properties":{"id":{"type":"string","minLength":1},"name":{"type":"string","minLength":1}},"additionalProperties":false},"productCount":{"type":"integer","minimum":0,"maximum":9007199254740991},"currency":{"type":"string","pattern":"^[A-Z]{3}$"},"locale":{"type":"string","maxLength":35,"pattern":"^[a-z]{2,3}(?:-[A-Za-z0-9]{2,8})*$"},"countryHint":{"type":"string","pattern":"^[A-Z]{2}$"},"country":{"type":"string","pattern":"^[A-Z]{2}$"},"contact":{"type":"object","properties":{"kind":{"type":"string","enum":["non_personal","personal"]},"email":{"type":"string","format":"email","pattern":"^(?:[A-Za-z0-9_'+\\-]+\\.)*[A-Za-z0-9_'+\\-]*[A-Za-z0-9_+-]@(?:[A-Za-z0-9][A-Za-z0-9\\-]*\\.)+[A-Za-z]{2,}$"},"phone":{"type":"string","pattern":"^\\+[1-9][0-9]{7,14}$"}},"required":["kind"],"additionalProperties":false},"foundedAt":{"type":"string","format":"date-time","pattern":"^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d:[0-5]\\d(?:\\.\\d+)?(?:Z))$"},"foundedPrecision":{"type":"string","enum":["day","month"]},"firstSeenAt":{"type":"string","format":"date-time","pattern":"^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d:[0-5]\\d(?:\\.\\d+)?(?:Z))$"},"preview":{"oneOf":[{"type":"object","properties":{"kind":{"type":"string","enum":["mosaic"]},"tiles":{"minItems":1,"maxItems":4,"type":"array","items":{"type":"string","format":"uri"}}},"required":["kind","tiles"],"additionalProperties":false},{"type":"object","properties":{"kind":{"type":"string","enum":["screenshot"]},"url":{"type":"string","format":"uri"},"thumbUrl":{"type":"string","format":"uri"},"tiles":{"minItems":1,"maxItems":4,"type":"array","items":{"type":"string","format":"uri"}}},"required":["kind","url"],"additionalProperties":false}]},"traffic":{"description":"Estimated monthly visits (latest finished month). confidence none = under ~1K; low carries a range instead of a figure; null = not measured yet.","anyOf":[{"type":"object","properties":{"month":{"type":"string","pattern":"^\\d{4}-\\d{2}$"},"confidence":{"type":"string","enum":["high","medium","low","none"]},"visits":{"anyOf":[{"type":"integer","minimum":0,"maximum":9007199254740991},{"type":"null"}]},"range":{"anyOf":[{"type":"object","properties":{"low":{"type":"integer","minimum":0,"maximum":9007199254740991},"high":{"type":"integer","minimum":0,"maximum":9007199254740991}},"required":["low","high"],"additionalProperties":false},{"type":"null"}]}},"required":["month","confidence","visits","range"],"additionalProperties":false},{"type":"null"}]},"signals":{"type":"object","properties":{"postPurchaseApps":{"description":"Post-purchase apps other than reviews (shipment tracking, returns, order status)","type":"integer","minimum":0,"maximum":9007199254740991},"hasReviewApp":{"type":"boolean"},"reviewCount":{"description":"Review total visible on the homepage; absent when no widget shows a count","type":"integer","minimum":0,"maximum":9007199254740991},"productsAdded30d":{"type":"integer","minimum":0,"maximum":9007199254740991},"copiedByStores":{"description":"Other stores that added this store's products later","type":"integer","minimum":0,"maximum":9007199254740991},"firstSeenAt":{"type":"string","format":"date-time","pattern":"^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d:[0-5]\\d(?:\\.\\d+)?(?:Z))$","description":"When Roasan first saw the store; not its launch date"}},"required":["firstSeenAt"],"additionalProperties":false},"appCount":{"type":"integer","minimum":0,"maximum":9007199254740991},"appLogos":{"maxItems":3,"type":"array","items":{"type":"object","properties":{"name":{"type":"string","minLength":1},"iconUrl":{"type":"string","format":"uri"}},"required":["name","iconUrl"],"additionalProperties":false}},"productTiles":{"maxItems":3,"type":"array","items":{"type":"object","properties":{"imageUrl":{"type":"string","format":"uri"},"title":{"type":"string","maxLength":500},"price":{"type":"string","pattern":"^\\d{1,10}(\\.\\d{1,2})?$"}},"required":["imageUrl","title"],"additionalProperties":false}},"trafficSpark":{"maxItems":12,"type":"array","items":{"anyOf":[{"type":"integer","minimum":0,"maximum":9007199254740991},{"type":"null"}]}},"businessCountry":{"type":"string","pattern":"^[A-Z]{2}$"},"topCountries":{"maxItems":3,"type":"array","items":{"type":"string","pattern":"^[A-Z]{2}$"}}},"required":["status","isHeadless","firstSeenAt"],"additionalProperties":false}},"nextCursor":{"anyOf":[{"type":"string","minLength":1},{"type":"null"}]}},"required":["items","nextCursor"],"additionalProperties":false}}}},"400":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"code":{"anyOf":[{"type":"string","enum":["validation","unauthenticated","scope_missing","forbidden","plan_required","email_unverified","not_found","conflict","limit_exceeded","rate_limited","row_budget_exhausted","refine_filters","upstream"]},{"type":"string","enum":["internal","timeout"]}]},"message":{"type":"string"},"details":{"type":"object","propertyNames":{"type":"string"},"additionalProperties":{}}},"required":["code","message"],"additionalProperties":false}},"required":["error"],"additionalProperties":false}}}},"401":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"code":{"anyOf":[{"type":"string","enum":["validation","unauthenticated","scope_missing","forbidden","plan_required","email_unverified","not_found","conflict","limit_exceeded","rate_limited","row_budget_exhausted","refine_filters","upstream"]},{"type":"string","enum":["internal","timeout"]}]},"message":{"type":"string"},"details":{"type":"object","propertyNames":{"type":"string"},"additionalProperties":{}}},"required":["code","message"],"additionalProperties":false}},"required":["error"],"additionalProperties":false}}}},"404":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"code":{"anyOf":[{"type":"string","enum":["validation","unauthenticated","scope_missing","forbidden","plan_required","email_unverified","not_found","conflict","limit_exceeded","rate_limited","row_budget_exhausted","refine_filters","upstream"]},{"type":"string","enum":["internal","timeout"]}]},"message":{"type":"string"},"details":{"type":"object","propertyNames":{"type":"string"},"additionalProperties":{}}},"required":["code","message"],"additionalProperties":false}},"required":["error"],"additionalProperties":false}}}}}},"patch":{"operationId":"patchCollectionsById","summary":"PATCH /v1/collections/{id} (collections)","tags":["collections"],"description":"PATCH /v1/collections/{id} (collections). Signed-in: send `Authorization: Bearer <API key>` (keys are created at /account/api-keys).","requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"name":{"type":"string","minLength":1,"maxLength":100}},"required":["name"],"additionalProperties":false}}}},"parameters":[{"schema":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"},"in":"path","name":"id","required":true}],"responses":{"200":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"id":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"},"name":{"type":"string","minLength":1},"storeCount":{"type":"integer","minimum":0,"maximum":9007199254740991},"createdAt":{"type":"string","format":"date-time","pattern":"^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d:[0-5]\\d(?:\\.\\d+)?(?:Z))$"}},"required":["id","name","storeCount","createdAt"],"additionalProperties":false}}}},"400":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"code":{"anyOf":[{"type":"string","enum":["validation","unauthenticated","scope_missing","forbidden","plan_required","email_unverified","not_found","conflict","limit_exceeded","rate_limited","row_budget_exhausted","refine_filters","upstream"]},{"type":"string","enum":["internal","timeout"]}]},"message":{"type":"string"},"details":{"type":"object","propertyNames":{"type":"string"},"additionalProperties":{}}},"required":["code","message"],"additionalProperties":false}},"required":["error"],"additionalProperties":false}}}},"401":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"code":{"anyOf":[{"type":"string","enum":["validation","unauthenticated","scope_missing","forbidden","plan_required","email_unverified","not_found","conflict","limit_exceeded","rate_limited","row_budget_exhausted","refine_filters","upstream"]},{"type":"string","enum":["internal","timeout"]}]},"message":{"type":"string"},"details":{"type":"object","propertyNames":{"type":"string"},"additionalProperties":{}}},"required":["code","message"],"additionalProperties":false}},"required":["error"],"additionalProperties":false}}}},"404":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"code":{"anyOf":[{"type":"string","enum":["validation","unauthenticated","scope_missing","forbidden","plan_required","email_unverified","not_found","conflict","limit_exceeded","rate_limited","row_budget_exhausted","refine_filters","upstream"]},{"type":"string","enum":["internal","timeout"]}]},"message":{"type":"string"},"details":{"type":"object","propertyNames":{"type":"string"},"additionalProperties":{}}},"required":["code","message"],"additionalProperties":false}},"required":["error"],"additionalProperties":false}}}},"409":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"code":{"anyOf":[{"type":"string","enum":["validation","unauthenticated","scope_missing","forbidden","plan_required","email_unverified","not_found","conflict","limit_exceeded","rate_limited","row_budget_exhausted","refine_filters","upstream"]},{"type":"string","enum":["internal","timeout"]}]},"message":{"type":"string"},"details":{"type":"object","propertyNames":{"type":"string"},"additionalProperties":{}}},"required":["code","message"],"additionalProperties":false}},"required":["error"],"additionalProperties":false}}}},"429":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"code":{"anyOf":[{"type":"string","enum":["validation","unauthenticated","scope_missing","forbidden","plan_required","email_unverified","not_found","conflict","limit_exceeded","rate_limited","row_budget_exhausted","refine_filters","upstream"]},{"type":"string","enum":["internal","timeout"]}]},"message":{"type":"string"},"details":{"type":"object","propertyNames":{"type":"string"},"additionalProperties":{}}},"required":["code","message"],"additionalProperties":false}},"required":["error"],"additionalProperties":false}}}}}},"delete":{"operationId":"deleteCollectionsById","summary":"DELETE /v1/collections/{id} (collections)","tags":["collections"],"description":"DELETE /v1/collections/{id} (collections). Signed-in: send `Authorization: Bearer <API key>` (keys are created at /account/api-keys).","parameters":[{"schema":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"},"in":"path","name":"id","required":true}],"responses":{"204":{"description":"No content"},"400":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"code":{"anyOf":[{"type":"string","enum":["validation","unauthenticated","scope_missing","forbidden","plan_required","email_unverified","not_found","conflict","limit_exceeded","rate_limited","row_budget_exhausted","refine_filters","upstream"]},{"type":"string","enum":["internal","timeout"]}]},"message":{"type":"string"},"details":{"type":"object","propertyNames":{"type":"string"},"additionalProperties":{}}},"required":["code","message"],"additionalProperties":false}},"required":["error"],"additionalProperties":false}}}},"401":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"code":{"anyOf":[{"type":"string","enum":["validation","unauthenticated","scope_missing","forbidden","plan_required","email_unverified","not_found","conflict","limit_exceeded","rate_limited","row_budget_exhausted","refine_filters","upstream"]},{"type":"string","enum":["internal","timeout"]}]},"message":{"type":"string"},"details":{"type":"object","propertyNames":{"type":"string"},"additionalProperties":{}}},"required":["code","message"],"additionalProperties":false}},"required":["error"],"additionalProperties":false}}}},"404":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"code":{"anyOf":[{"type":"string","enum":["validation","unauthenticated","scope_missing","forbidden","plan_required","email_unverified","not_found","conflict","limit_exceeded","rate_limited","row_budget_exhausted","refine_filters","upstream"]},{"type":"string","enum":["internal","timeout"]}]},"message":{"type":"string"},"details":{"type":"object","propertyNames":{"type":"string"},"additionalProperties":{}}},"required":["code","message"],"additionalProperties":false}},"required":["error"],"additionalProperties":false}}}}}}},"/v1/collections/{id}/apps":{"get":{"operationId":"getCollectionsByIdApps","summary":"GET /v1/collections/{id}/apps (collections)","tags":["collections"],"description":"GET /v1/collections/{id}/apps (collections). Signed-in: send `Authorization: Bearer <API key>` (keys are created at /account/api-keys).","parameters":[{"schema":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"},"in":"path","name":"id","required":true}],"responses":{"200":{"description":"Default Response","content":{"application/json":{"schema":{"maxItems":20,"type":"array","items":{"type":"object","properties":{"appClientId":{"type":"string","maxLength":19,"pattern":"^[1-9][0-9]*$"},"name":{"type":"string","minLength":1},"iconUrl":{"type":"string","format":"uri"},"storeCount":{"type":"integer","exclusiveMinimum":0,"maximum":9007199254740991}},"required":["appClientId","storeCount"],"additionalProperties":false}}}}},"400":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"code":{"anyOf":[{"type":"string","enum":["validation","unauthenticated","scope_missing","forbidden","plan_required","email_unverified","not_found","conflict","limit_exceeded","rate_limited","row_budget_exhausted","refine_filters","upstream"]},{"type":"string","enum":["internal","timeout"]}]},"message":{"type":"string"},"details":{"type":"object","propertyNames":{"type":"string"},"additionalProperties":{}}},"required":["code","message"],"additionalProperties":false}},"required":["error"],"additionalProperties":false}}}},"401":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"code":{"anyOf":[{"type":"string","enum":["validation","unauthenticated","scope_missing","forbidden","plan_required","email_unverified","not_found","conflict","limit_exceeded","rate_limited","row_budget_exhausted","refine_filters","upstream"]},{"type":"string","enum":["internal","timeout"]}]},"message":{"type":"string"},"details":{"type":"object","propertyNames":{"type":"string"},"additionalProperties":{}}},"required":["code","message"],"additionalProperties":false}},"required":["error"],"additionalProperties":false}}}},"404":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"code":{"anyOf":[{"type":"string","enum":["validation","unauthenticated","scope_missing","forbidden","plan_required","email_unverified","not_found","conflict","limit_exceeded","rate_limited","row_budget_exhausted","refine_filters","upstream"]},{"type":"string","enum":["internal","timeout"]}]},"message":{"type":"string"},"details":{"type":"object","propertyNames":{"type":"string"},"additionalProperties":{}}},"required":["code","message"],"additionalProperties":false}},"required":["error"],"additionalProperties":false}}}}}}},"/v1/collections/{id}/stores/{ref}":{"put":{"operationId":"putCollectionsByIdStoresByRef","summary":"PUT /v1/collections/{id}/stores/{ref} (collections)","tags":["collections"],"description":"PUT /v1/collections/{id}/stores/{ref} (collections). Signed-in: send `Authorization: Bearer <API key>` (keys are created at /account/api-keys).","requestBody":{"required":true,"content":{"application/json":{"schema":{"anyOf":[{"type":"object","properties":{},"additionalProperties":false},{"type":"null"}]}}}},"parameters":[{"schema":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"},"in":"path","name":"id","required":true},{"schema":{"type":"string","minLength":1,"maxLength":253,"pattern":"^[A-Za-z0-9.-]+$"},"in":"path","name":"ref","required":true}],"responses":{"204":{"description":"No content"},"400":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"code":{"anyOf":[{"type":"string","enum":["validation","unauthenticated","scope_missing","forbidden","plan_required","email_unverified","not_found","conflict","limit_exceeded","rate_limited","row_budget_exhausted","refine_filters","upstream"]},{"type":"string","enum":["internal","timeout"]}]},"message":{"type":"string"},"details":{"type":"object","propertyNames":{"type":"string"},"additionalProperties":{}}},"required":["code","message"],"additionalProperties":false}},"required":["error"],"additionalProperties":false}}}},"401":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"code":{"anyOf":[{"type":"string","enum":["validation","unauthenticated","scope_missing","forbidden","plan_required","email_unverified","not_found","conflict","limit_exceeded","rate_limited","row_budget_exhausted","refine_filters","upstream"]},{"type":"string","enum":["internal","timeout"]}]},"message":{"type":"string"},"details":{"type":"object","propertyNames":{"type":"string"},"additionalProperties":{}}},"required":["code","message"],"additionalProperties":false}},"required":["error"],"additionalProperties":false}}}},"404":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"code":{"anyOf":[{"type":"string","enum":["validation","unauthenticated","scope_missing","forbidden","plan_required","email_unverified","not_found","conflict","limit_exceeded","rate_limited","row_budget_exhausted","refine_filters","upstream"]},{"type":"string","enum":["internal","timeout"]}]},"message":{"type":"string"},"details":{"type":"object","propertyNames":{"type":"string"},"additionalProperties":{}}},"required":["code","message"],"additionalProperties":false}},"required":["error"],"additionalProperties":false}}}},"429":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"code":{"anyOf":[{"type":"string","enum":["validation","unauthenticated","scope_missing","forbidden","plan_required","email_unverified","not_found","conflict","limit_exceeded","rate_limited","row_budget_exhausted","refine_filters","upstream"]},{"type":"string","enum":["internal","timeout"]}]},"message":{"type":"string"},"details":{"type":"object","propertyNames":{"type":"string"},"additionalProperties":{}}},"required":["code","message"],"additionalProperties":false}},"required":["error"],"additionalProperties":false}}}}}},"delete":{"operationId":"deleteCollectionsByIdStoresByRef","summary":"DELETE /v1/collections/{id}/stores/{ref} (collections)","tags":["collections"],"description":"DELETE /v1/collections/{id}/stores/{ref} (collections). Signed-in: send `Authorization: Bearer <API key>` (keys are created at /account/api-keys).","parameters":[{"schema":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"},"in":"path","name":"id","required":true},{"schema":{"type":"string","minLength":1,"maxLength":253,"pattern":"^[A-Za-z0-9.-]+$"},"in":"path","name":"ref","required":true}],"responses":{"204":{"description":"No content"},"400":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"code":{"anyOf":[{"type":"string","enum":["validation","unauthenticated","scope_missing","forbidden","plan_required","email_unverified","not_found","conflict","limit_exceeded","rate_limited","row_budget_exhausted","refine_filters","upstream"]},{"type":"string","enum":["internal","timeout"]}]},"message":{"type":"string"},"details":{"type":"object","propertyNames":{"type":"string"},"additionalProperties":{}}},"required":["code","message"],"additionalProperties":false}},"required":["error"],"additionalProperties":false}}}},"401":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"code":{"anyOf":[{"type":"string","enum":["validation","unauthenticated","scope_missing","forbidden","plan_required","email_unverified","not_found","conflict","limit_exceeded","rate_limited","row_budget_exhausted","refine_filters","upstream"]},{"type":"string","enum":["internal","timeout"]}]},"message":{"type":"string"},"details":{"type":"object","propertyNames":{"type":"string"},"additionalProperties":{}}},"required":["code","message"],"additionalProperties":false}},"required":["error"],"additionalProperties":false}}}},"404":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"code":{"anyOf":[{"type":"string","enum":["validation","unauthenticated","scope_missing","forbidden","plan_required","email_unverified","not_found","conflict","limit_exceeded","rate_limited","row_budget_exhausted","refine_filters","upstream"]},{"type":"string","enum":["internal","timeout"]}]},"message":{"type":"string"},"details":{"type":"object","propertyNames":{"type":"string"},"additionalProperties":{}}},"required":["code","message"],"additionalProperties":false}},"required":["error"],"additionalProperties":false}}}}}}},"/v1/follows":{"get":{"operationId":"getFollows","summary":"GET /v1/follows (follows)","tags":["follows"],"description":"GET /v1/follows (follows). Signed-in: send `Authorization: Bearer <API key>` (keys are created at /account/api-keys).","parameters":[{"schema":{"type":"string","minLength":1,"maxLength":512},"in":"query","name":"cursor","required":false},{"schema":{"default":20,"type":"integer","minimum":1,"maximum":50},"in":"query","name":"limit","required":false}],"responses":{"200":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"items":{"maxItems":50,"type":"array","items":{"type":"object","properties":{"storeId":{"type":"string","maxLength":19,"pattern":"^[1-9][0-9]*$"},"kind":{"type":"string","enum":["own","following"]},"createdAt":{"type":"string","format":"date-time","pattern":"^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d:[0-5]\\d(?:\\.\\d+)?(?:Z))$"},"handle":{"type":"string","minLength":1},"primaryDomain":{"type":"string","minLength":1}},"required":["storeId","kind","createdAt"],"additionalProperties":false}},"nextCursor":{"anyOf":[{"type":"string","minLength":1},{"type":"null"}]}},"required":["items","nextCursor"],"additionalProperties":false}}}},"400":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"code":{"anyOf":[{"type":"string","enum":["validation","unauthenticated","scope_missing","forbidden","plan_required","email_unverified","not_found","conflict","limit_exceeded","rate_limited","row_budget_exhausted","refine_filters","upstream"]},{"type":"string","enum":["internal","timeout"]}]},"message":{"type":"string"},"details":{"type":"object","propertyNames":{"type":"string"},"additionalProperties":{}}},"required":["code","message"],"additionalProperties":false}},"required":["error"],"additionalProperties":false}}}},"401":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"code":{"anyOf":[{"type":"string","enum":["validation","unauthenticated","scope_missing","forbidden","plan_required","email_unverified","not_found","conflict","limit_exceeded","rate_limited","row_budget_exhausted","refine_filters","upstream"]},{"type":"string","enum":["internal","timeout"]}]},"message":{"type":"string"},"details":{"type":"object","propertyNames":{"type":"string"},"additionalProperties":{}}},"required":["code","message"],"additionalProperties":false}},"required":["error"],"additionalProperties":false}}}}}}},"/v1/follows/{ref}":{"get":{"operationId":"getFollowsByRef","summary":"GET /v1/follows/{ref} (follows)","tags":["follows"],"description":"GET /v1/follows/{ref} (follows). Signed-in: send `Authorization: Bearer <API key>` (keys are created at /account/api-keys).","parameters":[{"schema":{"type":"string","minLength":1,"maxLength":253,"pattern":"^[A-Za-z0-9.-]+$"},"in":"path","name":"ref","required":true}],"responses":{"200":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"storeId":{"type":"string","maxLength":19,"pattern":"^[1-9][0-9]*$"},"kind":{"type":"string","enum":["own","following"]},"createdAt":{"type":"string","format":"date-time","pattern":"^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d:[0-5]\\d(?:\\.\\d+)?(?:Z))$"},"handle":{"type":"string","minLength":1},"primaryDomain":{"type":"string","minLength":1}},"required":["storeId","kind","createdAt"],"additionalProperties":false}}}},"400":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"code":{"anyOf":[{"type":"string","enum":["validation","unauthenticated","scope_missing","forbidden","plan_required","email_unverified","not_found","conflict","limit_exceeded","rate_limited","row_budget_exhausted","refine_filters","upstream"]},{"type":"string","enum":["internal","timeout"]}]},"message":{"type":"string"},"details":{"type":"object","propertyNames":{"type":"string"},"additionalProperties":{}}},"required":["code","message"],"additionalProperties":false}},"required":["error"],"additionalProperties":false}}}},"401":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"code":{"anyOf":[{"type":"string","enum":["validation","unauthenticated","scope_missing","forbidden","plan_required","email_unverified","not_found","conflict","limit_exceeded","rate_limited","row_budget_exhausted","refine_filters","upstream"]},{"type":"string","enum":["internal","timeout"]}]},"message":{"type":"string"},"details":{"type":"object","propertyNames":{"type":"string"},"additionalProperties":{}}},"required":["code","message"],"additionalProperties":false}},"required":["error"],"additionalProperties":false}}}},"404":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"code":{"anyOf":[{"type":"string","enum":["validation","unauthenticated","scope_missing","forbidden","plan_required","email_unverified","not_found","conflict","limit_exceeded","rate_limited","row_budget_exhausted","refine_filters","upstream"]},{"type":"string","enum":["internal","timeout"]}]},"message":{"type":"string"},"details":{"type":"object","propertyNames":{"type":"string"},"additionalProperties":{}}},"required":["code","message"],"additionalProperties":false}},"required":["error"],"additionalProperties":false}}}}}},"put":{"operationId":"putFollowsByRef","summary":"PUT /v1/follows/{ref} (follows)","tags":["follows"],"description":"PUT /v1/follows/{ref} (follows). Signed-in: send `Authorization: Bearer <API key>` (keys are created at /account/api-keys).","requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"kind":{"type":"string","enum":["own","following"]}},"required":["kind"],"additionalProperties":false}}}},"parameters":[{"schema":{"type":"string","minLength":1,"maxLength":253,"pattern":"^[A-Za-z0-9.-]+$"},"in":"path","name":"ref","required":true}],"responses":{"200":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"storeId":{"type":"string","maxLength":19,"pattern":"^[1-9][0-9]*$"},"kind":{"type":"string","enum":["own","following"]},"createdAt":{"type":"string","format":"date-time","pattern":"^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d:[0-5]\\d(?:\\.\\d+)?(?:Z))$"},"handle":{"type":"string","minLength":1},"primaryDomain":{"type":"string","minLength":1}},"required":["storeId","kind","createdAt"],"additionalProperties":false}}}},"400":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"code":{"anyOf":[{"type":"string","enum":["validation","unauthenticated","scope_missing","forbidden","plan_required","email_unverified","not_found","conflict","limit_exceeded","rate_limited","row_budget_exhausted","refine_filters","upstream"]},{"type":"string","enum":["internal","timeout"]}]},"message":{"type":"string"},"details":{"type":"object","propertyNames":{"type":"string"},"additionalProperties":{}}},"required":["code","message"],"additionalProperties":false}},"required":["error"],"additionalProperties":false}}}},"401":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"code":{"anyOf":[{"type":"string","enum":["validation","unauthenticated","scope_missing","forbidden","plan_required","email_unverified","not_found","conflict","limit_exceeded","rate_limited","row_budget_exhausted","refine_filters","upstream"]},{"type":"string","enum":["internal","timeout"]}]},"message":{"type":"string"},"details":{"type":"object","propertyNames":{"type":"string"},"additionalProperties":{}}},"required":["code","message"],"additionalProperties":false}},"required":["error"],"additionalProperties":false}}}},"404":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"code":{"anyOf":[{"type":"string","enum":["validation","unauthenticated","scope_missing","forbidden","plan_required","email_unverified","not_found","conflict","limit_exceeded","rate_limited","row_budget_exhausted","refine_filters","upstream"]},{"type":"string","enum":["internal","timeout"]}]},"message":{"type":"string"},"details":{"type":"object","propertyNames":{"type":"string"},"additionalProperties":{}}},"required":["code","message"],"additionalProperties":false}},"required":["error"],"additionalProperties":false}}}},"429":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"code":{"anyOf":[{"type":"string","enum":["validation","unauthenticated","scope_missing","forbidden","plan_required","email_unverified","not_found","conflict","limit_exceeded","rate_limited","row_budget_exhausted","refine_filters","upstream"]},{"type":"string","enum":["internal","timeout"]}]},"message":{"type":"string"},"details":{"type":"object","propertyNames":{"type":"string"},"additionalProperties":{}}},"required":["code","message"],"additionalProperties":false}},"required":["error"],"additionalProperties":false}}}}}},"delete":{"operationId":"deleteFollowsByRef","summary":"DELETE /v1/follows/{ref} (follows)","tags":["follows"],"description":"DELETE /v1/follows/{ref} (follows). Signed-in: send `Authorization: Bearer <API key>` (keys are created at /account/api-keys).","parameters":[{"schema":{"type":"string","minLength":1,"maxLength":253,"pattern":"^[A-Za-z0-9.-]+$"},"in":"path","name":"ref","required":true}],"responses":{"204":{"description":"No content"},"400":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"code":{"anyOf":[{"type":"string","enum":["validation","unauthenticated","scope_missing","forbidden","plan_required","email_unverified","not_found","conflict","limit_exceeded","rate_limited","row_budget_exhausted","refine_filters","upstream"]},{"type":"string","enum":["internal","timeout"]}]},"message":{"type":"string"},"details":{"type":"object","propertyNames":{"type":"string"},"additionalProperties":{}}},"required":["code","message"],"additionalProperties":false}},"required":["error"],"additionalProperties":false}}}},"401":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"code":{"anyOf":[{"type":"string","enum":["validation","unauthenticated","scope_missing","forbidden","plan_required","email_unverified","not_found","conflict","limit_exceeded","rate_limited","row_budget_exhausted","refine_filters","upstream"]},{"type":"string","enum":["internal","timeout"]}]},"message":{"type":"string"},"details":{"type":"object","propertyNames":{"type":"string"},"additionalProperties":{}}},"required":["code","message"],"additionalProperties":false}},"required":["error"],"additionalProperties":false}}}},"404":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"code":{"anyOf":[{"type":"string","enum":["validation","unauthenticated","scope_missing","forbidden","plan_required","email_unverified","not_found","conflict","limit_exceeded","rate_limited","row_budget_exhausted","refine_filters","upstream"]},{"type":"string","enum":["internal","timeout"]}]},"message":{"type":"string"},"details":{"type":"object","propertyNames":{"type":"string"},"additionalProperties":{}}},"required":["code","message"],"additionalProperties":false}},"required":["error"],"additionalProperties":false}}}}}}},"/v1/collections/{id}/export.csv":{"get":{"operationId":"getCollectionsByIdExportCsv","summary":"GET /v1/collections/{id}/export.csv (collections)","tags":["collections"],"description":"GET /v1/collections/{id}/export.csv (collections). Signed-in: send `Authorization: Bearer <API key>` (keys are created at /account/api-keys).","parameters":[{"schema":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"},"in":"path","name":"id","required":true}],"responses":{"200":{"description":"text/csv; charset=utf-8, streamed","content":{"application/json":{"schema":{"type":"string","description":"text/csv; charset=utf-8, streamed"}}}},"401":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"code":{"anyOf":[{"type":"string","enum":["validation","unauthenticated","scope_missing","forbidden","plan_required","email_unverified","not_found","conflict","limit_exceeded","rate_limited","row_budget_exhausted","refine_filters","upstream"]},{"type":"string","enum":["internal","timeout"]}]},"message":{"type":"string"},"details":{"type":"object","propertyNames":{"type":"string"},"additionalProperties":{}}},"required":["code","message"],"additionalProperties":false}},"required":["error"],"additionalProperties":false}}}},"403":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"code":{"anyOf":[{"type":"string","enum":["validation","unauthenticated","scope_missing","forbidden","plan_required","email_unverified","not_found","conflict","limit_exceeded","rate_limited","row_budget_exhausted","refine_filters","upstream"]},{"type":"string","enum":["internal","timeout"]}]},"message":{"type":"string"},"details":{"type":"object","propertyNames":{"type":"string"},"additionalProperties":{}}},"required":["code","message"],"additionalProperties":false}},"required":["error"],"additionalProperties":false}}}},"404":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"code":{"anyOf":[{"type":"string","enum":["validation","unauthenticated","scope_missing","forbidden","plan_required","email_unverified","not_found","conflict","limit_exceeded","rate_limited","row_budget_exhausted","refine_filters","upstream"]},{"type":"string","enum":["internal","timeout"]}]},"message":{"type":"string"},"details":{"type":"object","propertyNames":{"type":"string"},"additionalProperties":{}}},"required":["code","message"],"additionalProperties":false}},"required":["error"],"additionalProperties":false}}}},"429":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"code":{"anyOf":[{"type":"string","enum":["validation","unauthenticated","scope_missing","forbidden","plan_required","email_unverified","not_found","conflict","limit_exceeded","rate_limited","row_budget_exhausted","refine_filters","upstream"]},{"type":"string","enum":["internal","timeout"]}]},"message":{"type":"string"},"details":{"type":"object","propertyNames":{"type":"string"},"additionalProperties":{}}},"required":["code","message"],"additionalProperties":false}},"required":["error"],"additionalProperties":false}}}}}}},"/v1/products":{"get":{"operationId":"getProducts","summary":"GET /v1/products (products)","tags":["products"],"description":"GET /v1/products (products). Signed-in: send `Authorization: Bearer <API key>` (keys are created at /account/api-keys).","parameters":[{"schema":{"type":"string","maxLength":200},"in":"query","name":"q","required":false},{"schema":{"type":"string","enum":["animals-pet-supplies","apparel-accessories","arts-entertainment","baby-toddler","bundles","business-industrial","cameras-optics","electronics","food-beverages-tobacco","furniture","gift-cards","hardware","health-beauty","home-garden","luggage-bags","mature","media","office-supplies","product-add-ons","religious-ceremonial","services","software","sporting-goods","toys-games","uncategorized","vehicles-parts","other","fishing-hunting","dog-supplies","cat-supplies","aquarium-fish","small-pets-birds-reptiles","pet-home-travel","pet-apparel","pet-health-grooming","everyday-clothing","streetwear","graphic-tees","activewear","lingerie-underwear","swimwear","sleepwear-loungewear","modest-fashion","ethnic-traditional-wear","maternity-wear","outerwear","workwear-uniforms","sneakers","shoes-boots","fine-jewelry","fashion-jewelry","body-jewelry","watches","handbags-wallets","hats-caps","eyewear","fashion-accessories","costumes-cosplay","art-supplies","craft-kits","knitting-sewing","stickers-decals","trading-cards","collectibles-memorabilia","model-kits-hobby","musical-instruments","party-supplies","gift-wrap-cards","flowers-bouquets","event-tickets","baby-feeding","baby-gear","baby-care","baby-toys","nursery","product-bundles","salon-beauty-pro","tattoo-piercing-supplies","medical-dental-pro","food-service-equipment","packaging-shipping","signage-neon","promotional-merch","industrial-equipment","cameras-photography","binoculars-optics","phone-accessories","phones-tablets","chargers-cables","audio-headphones","pro-audio-dj","gaming-gear","computer-accessories","wearable-tech","smart-home","tv-projectors","drones","three-d-printing","electronic-components","coffee","tea","snacks","candy-chocolate","sauces-spices","pantry-fresh-food","alcoholic-beverages","functional-drinks","cbd-hemp","vape-tobacco","living-dining-furniture","bedroom-mattresses","office-furniture","outdoor-furniture","storage-furniture","gift-cards-vouchers","tools","home-improvement","solar-portable-power","knives-edc","skincare","makeup","nail-care","hair-care","wigs-hair-extensions","fragrance","bath-body","mens-grooming","beauty-devices","oral-care","supplements","sports-nutrition","home-health","pain-relief-orthopedic","massage-relaxation","feminine-care","candles-home-fragrance","wall-art-prints","home-decor","rugs-curtains","bedding-linens","seasonal-decor","kitchen-gadgets","cookware-bakeware","kitchen-appliances","bbq-grilling","drinkware-tableware","lighting","home-organization","cleaning-laundry","climate-air","gardening","plants-seeds","outdoor-living","pool-spa","home-security","backpacks-everyday-bags","travel-luggage","sexual-wellness","weapons-tactical","books-magazines","music-recordings","courses-coaching","stationery","office-equipment","shipping-protection","service-add-ons","wedding","religious-items","spiritual-metaphysical","memorial","service-listings","digital-products","software-apps","virtual-currency","fitness-equipment","yoga-pilates","camping-hiking","fishing","hunting","golf","cycling","water-sports","winter-sports","skate-scooters","team-sports","racket-sports","combat-sports","equestrian","game-room","board-games","collectible-figures","plush-toys","dolls-pretend-play","building-toys","educational-toys","rc-vehicles","outdoor-play","fidget-sensory-toys","car-accessories","car-care-detailing","auto-parts","motorcycle-gear","e-mobility","offroad-overlanding","marine-boating","vehicles-for-sale"]},"in":"query","name":"category","required":false},{"schema":{"type":"string","maxLength":2000},"in":"query","name":"tag","required":false,"description":"Comma-separated tag slugs (20 at most); a result must carry every listed tag (AND). Duplicates and order are ignored."},{"schema":{"type":"string"},"in":"query","name":"country","required":false},{"schema":{"type":"number","minimum":0},"in":"query","name":"priceMin","required":false},{"schema":{"type":"number","minimum":0},"in":"query","name":"priceMax","required":false},{"schema":{"type":"integer","minimum":1,"maximum":9007199254740991},"in":"query","name":"minStores","required":false},{"schema":{"type":"string","format":"date-time","pattern":"^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d:[0-5]\\d(?:\\.\\d+)?(?:Z))$"},"in":"query","name":"addedSince","required":false},{"schema":{"type":"integer","minimum":1,"maximum":99},"in":"query","name":"discount","required":false},{"schema":{"type":"string","enum":["in","out"]},"in":"query","name":"stock","required":false},{"schema":{"type":"integer","minimum":1,"maximum":10000},"in":"query","name":"variantsMin","required":false},{"schema":{"type":"integer","minimum":1,"maximum":10000},"in":"query","name":"variantsMax","required":false},{"schema":{"type":"string","minLength":1,"maxLength":200},"in":"query","name":"vendor","required":false},{"schema":{"type":"string","minLength":1,"maxLength":200},"in":"query","name":"type","required":false},{"schema":{"type":"string"},"in":"query","name":"rising","required":false},{"schema":{"type":"string","maxLength":2000},"in":"query","name":"themeName","required":false,"description":"Comma-separated theme names (20 at most), case-insensitive; a result's store runs any of them (OR)."},{"schema":{"type":"string","maxLength":2000},"in":"query","name":"app","required":false,"description":"Comma-separated app client ids (20 at most); a result's store runs any of them (OR)."},{"schema":{"type":"integer","minimum":0,"maximum":2000000000},"in":"query","name":"visitsMin","required":false},{"schema":{"type":"integer","minimum":0,"maximum":2000000000},"in":"query","name":"visitsMax","required":false},{"schema":{"type":"string","pattern":"^[A-Za-z0-9_-]{16,64}$"},"in":"query","name":"image","required":false},{"schema":{"type":"string","enum":["relevance","momentum","stores","new","priceAsc","priceDesc","discount","variants"]},"in":"query","name":"sort","required":false},{"schema":{"type":"string","minLength":1,"maxLength":512},"in":"query","name":"cursor","required":false},{"schema":{"default":20,"type":"integer","minimum":1,"maximum":50},"in":"query","name":"limit","required":false}],"responses":{"200":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"items":{"maxItems":50,"type":"array","items":{"type":"object","properties":{"groupId":{"type":"string","pattern":"^[A-Za-z0-9_-]{2,400}$"},"title":{"type":"string"},"imageUrl":{"type":"string","format":"uri"},"storedImageUrl":{"description":"Roasan's stored copy of the main image (800 px WebP); prefer it to imageUrl","type":"string","format":"uri"},"match":{"type":"string","enum":["title_vendor","single","visual"]},"storeCount":{"type":"integer","minimum":0,"maximum":9007199254740991,"description":"Stores currently listing the same product (lower bound: only each store's newest products are observed). Not sales volume or revenue."},"storeCount7d":{"type":"integer","minimum":0,"maximum":9007199254740991,"description":"Stores that added the product to their newest products in the last 7 days"},"storeCount30d":{"type":"integer","minimum":0,"maximum":9007199254740991,"description":"Stores that added the product to their newest products in the last 30 days"},"priceUsdMin":{"type":"number","minimum":0},"priceUsdMax":{"type":"number","minimum":0},"niche":{"type":"string","enum":["animals-pet-supplies","apparel-accessories","arts-entertainment","baby-toddler","bundles","business-industrial","cameras-optics","electronics","food-beverages-tobacco","furniture","gift-cards","hardware","health-beauty","home-garden","luggage-bags","mature","media","office-supplies","product-add-ons","religious-ceremonial","services","software","sporting-goods","toys-games","uncategorized","vehicles-parts","other"]},"firstSeenAt":{"type":"string","format":"date-time","pattern":"^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d:[0-5]\\d(?:\\.\\d+)?(?:Z))$","description":"When Roasan first saw the product"},"countries":{"description":"Country hints of the listing stores, most stores first (at most 5)","maxItems":5,"type":"array","items":{"type":"string","minLength":2,"maxLength":2}},"countryCount":{"description":"Distinct countries of the listing stores (`countries` shows at most 5)","type":"integer","minimum":0,"maximum":9007199254740991},"similarity":{"description":"Image search only (23 §10): cosine of the best member image","type":"number","minimum":-1,"maximum":1},"store":{"description":"The group's representative store","type":"object","properties":{"handle":{"type":"string","minLength":1},"primaryDomain":{"type":"string","minLength":1}},"additionalProperties":false}},"required":["groupId","match","storeCount","storeCount7d","storeCount30d","firstSeenAt"],"additionalProperties":false}},"nextCursor":{"anyOf":[{"type":"string","minLength":1},{"type":"null"}]},"locked":{"type":"boolean","enum":[true]}},"required":["items","nextCursor"],"additionalProperties":false}}}},"400":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"code":{"anyOf":[{"type":"string","enum":["validation","unauthenticated","scope_missing","forbidden","plan_required","email_unverified","not_found","conflict","limit_exceeded","rate_limited","row_budget_exhausted","refine_filters","upstream"]},{"type":"string","enum":["internal","timeout"]}]},"message":{"type":"string"},"details":{"type":"object","propertyNames":{"type":"string"},"additionalProperties":{}}},"required":["code","message"],"additionalProperties":false}},"required":["error"],"additionalProperties":false}}}},"401":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"code":{"anyOf":[{"type":"string","enum":["validation","unauthenticated","scope_missing","forbidden","plan_required","email_unverified","not_found","conflict","limit_exceeded","rate_limited","row_budget_exhausted","refine_filters","upstream"]},{"type":"string","enum":["internal","timeout"]}]},"message":{"type":"string"},"details":{"type":"object","propertyNames":{"type":"string"},"additionalProperties":{}}},"required":["code","message"],"additionalProperties":false}},"required":["error"],"additionalProperties":false}}}},"403":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"code":{"anyOf":[{"type":"string","enum":["validation","unauthenticated","scope_missing","forbidden","plan_required","email_unverified","not_found","conflict","limit_exceeded","rate_limited","row_budget_exhausted","refine_filters","upstream"]},{"type":"string","enum":["internal","timeout"]}]},"message":{"type":"string"},"details":{"type":"object","propertyNames":{"type":"string"},"additionalProperties":{}}},"required":["code","message"],"additionalProperties":false}},"required":["error"],"additionalProperties":false}}}},"404":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"code":{"type":"string","enum":["image_search_expired"]},"message":{"type":"string"}},"required":["code","message"],"additionalProperties":false}},"required":["error"],"additionalProperties":false}}}},"429":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"code":{"anyOf":[{"type":"string","enum":["validation","unauthenticated","scope_missing","forbidden","plan_required","email_unverified","not_found","conflict","limit_exceeded","rate_limited","row_budget_exhausted","refine_filters","upstream"]},{"type":"string","enum":["internal","timeout"]}]},"message":{"type":"string"},"details":{"type":"object","propertyNames":{"type":"string"},"additionalProperties":{}}},"required":["code","message"],"additionalProperties":false}},"required":["error"],"additionalProperties":false}}}}}}},"/v1/products/groups/series":{"get":{"operationId":"getProductsGroupsSeries","summary":"GET /v1/products/groups/series (products)","tags":["products"],"description":"GET /v1/products/groups/series (products). Signed-in: send `Authorization: Bearer <API key>` (keys are created at /account/api-keys).","parameters":[{"schema":{"type":"string"},"in":"query","name":"ids","required":true}],"responses":{"200":{"description":"Default Response","content":{"application/json":{"schema":{"type":"array","items":{"type":"object","properties":{"groupId":{"type":"string","pattern":"^[A-Za-z0-9_-]{2,400}$"},"days":{"minItems":7,"maxItems":7,"type":"array","items":{"type":"integer","minimum":0,"maximum":9007199254740991}}},"required":["groupId","days"],"additionalProperties":false}}}}},"400":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"code":{"anyOf":[{"type":"string","enum":["validation","unauthenticated","scope_missing","forbidden","plan_required","email_unverified","not_found","conflict","limit_exceeded","rate_limited","row_budget_exhausted","refine_filters","upstream"]},{"type":"string","enum":["internal","timeout"]}]},"message":{"type":"string"},"details":{"type":"object","propertyNames":{"type":"string"},"additionalProperties":{}}},"required":["code","message"],"additionalProperties":false}},"required":["error"],"additionalProperties":false}}}},"401":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"code":{"anyOf":[{"type":"string","enum":["validation","unauthenticated","scope_missing","forbidden","plan_required","email_unverified","not_found","conflict","limit_exceeded","rate_limited","row_budget_exhausted","refine_filters","upstream"]},{"type":"string","enum":["internal","timeout"]}]},"message":{"type":"string"},"details":{"type":"object","propertyNames":{"type":"string"},"additionalProperties":{}}},"required":["code","message"],"additionalProperties":false}},"required":["error"],"additionalProperties":false}}}},"403":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"code":{"anyOf":[{"type":"string","enum":["validation","unauthenticated","scope_missing","forbidden","plan_required","email_unverified","not_found","conflict","limit_exceeded","rate_limited","row_budget_exhausted","refine_filters","upstream"]},{"type":"string","enum":["internal","timeout"]}]},"message":{"type":"string"},"details":{"type":"object","propertyNames":{"type":"string"},"additionalProperties":{}}},"required":["code","message"],"additionalProperties":false}},"required":["error"],"additionalProperties":false}}}},"429":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"code":{"anyOf":[{"type":"string","enum":["validation","unauthenticated","scope_missing","forbidden","plan_required","email_unverified","not_found","conflict","limit_exceeded","rate_limited","row_budget_exhausted","refine_filters","upstream"]},{"type":"string","enum":["internal","timeout"]}]},"message":{"type":"string"},"details":{"type":"object","propertyNames":{"type":"string"},"additionalProperties":{}}},"required":["code","message"],"additionalProperties":false}},"required":["error"],"additionalProperties":false}}}}}}},"/v1/products/groups/{id}/insights":{"get":{"operationId":"getProductsGroupsByIdInsights","summary":"GET /v1/products/groups/{id}/insights (products)","tags":["products"],"description":"GET /v1/products/groups/{id}/insights (products). Signed-in: send `Authorization: Bearer <API key>` (keys are created at /account/api-keys).","parameters":[{"schema":{"type":"string","pattern":"^[A-Za-z0-9_-]{2,400}$"},"in":"path","name":"id","required":true}],"responses":{"200":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"storeCount":{"type":"integer","minimum":0,"maximum":9007199254740991},"pageCount":{"type":"integer","minimum":0,"maximum":9007199254740991},"storeSeries":{"type":"array","items":{"type":"object","properties":{"month":{"type":"string","pattern":"^\\d{4}-\\d{2}$"},"stores":{"type":"integer","minimum":1,"maximum":9007199254740991}},"required":["month","stores"],"additionalProperties":false}},"storeDaily":{"type":"array","items":{"type":"object","properties":{"day":{"type":"string","pattern":"^\\d{4}-\\d{2}-\\d{2}$"},"stores":{"type":"integer","minimum":1,"maximum":9007199254740991}},"required":["day","stores"],"additionalProperties":false}},"undatedStores":{"type":"integer","minimum":0,"maximum":9007199254740991},"rankTop3":{"type":"integer","minimum":0,"maximum":9007199254740991},"rankFirst":{"type":"integer","minimum":0,"maximum":9007199254740991},"prices":{"type":"object","properties":{"min":{"type":"number","minimum":0},"max":{"type":"number","minimum":0},"median":{"type":"number","minimum":0},"common":{"type":"object","properties":{"from":{"type":"number","minimum":0},"to":{"type":"number","minimum":0},"pages":{"type":"integer","minimum":2,"maximum":9007199254740991}},"required":["from","to","pages"],"additionalProperties":false},"pages":{"type":"integer","minimum":1,"maximum":9007199254740991},"bins":{"maxItems":18,"type":"array","items":{"type":"object","properties":{"from":{"type":"number","minimum":0},"to":{"type":"number","minimum":0},"pages":{"type":"integer","minimum":0,"maximum":9007199254740991}},"required":["from","pages"],"additionalProperties":false}}},"required":["min","max","median","pages","bins"],"additionalProperties":false},"markets":{"type":"array","items":{"type":"object","properties":{"country":{"type":"string","pattern":"^[A-Z]{2}$"},"stores":{"type":"integer","minimum":1,"maximum":9007199254740991},"medianPriceUsd":{"type":"number","minimum":0},"minPriceUsd":{"type":"number","minimum":0},"maxPriceUsd":{"type":"number","minimum":0},"top3":{"type":"integer","minimum":0,"maximum":9007199254740991},"added180d":{"type":"integer","minimum":0,"maximum":9007199254740991},"firstAddedAt":{"type":"string","format":"date-time","pattern":"^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d:[0-5]\\d(?:\\.\\d+)?(?:Z))$"},"lastAddedAt":{"type":"string","format":"date-time","pattern":"^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d:[0-5]\\d(?:\\.\\d+)?(?:Z))$"}},"required":["country","stores","top3","added180d"],"additionalProperties":false}},"pixels":{"type":"array","items":{"type":"object","properties":{"platform":{"type":"string","minLength":1},"stores":{"type":"integer","minimum":1,"maximum":9007199254740991}},"required":["platform","stores"],"additionalProperties":false}},"noPixelStores":{"type":"integer","minimum":0,"maximum":9007199254740991},"options":{"maxItems":8,"type":"array","items":{"type":"object","properties":{"name":{"type":"string","minLength":1},"stores":{"type":"integer","minimum":1,"maximum":9007199254740991}},"required":["name","stores"],"additionalProperties":false}},"related":{"maxItems":8,"type":"array","items":{"type":"object","properties":{"groupId":{"type":"string","pattern":"^[A-Za-z0-9_-]{2,400}$"},"title":{"type":"string"},"imageUrl":{"type":"string","format":"uri"},"store":{"type":"object","properties":{"handle":{"description":"Canonical myshopify handle. Absent when unknown (headless stores); primaryDomain is then always present and serves as the store reference.","type":"string","maxLength":77,"pattern":"^[a-z0-9](?:[a-z0-9-]{0,61}[a-z0-9])?\\.myshopify\\.com$"},"primaryDomain":{"type":"string","maxLength":253,"pattern":"^(?:[a-z0-9](?:[a-z0-9-]{0,61}[a-z0-9])?\\.)+[a-z](?:[a-z0-9-]{0,61}[a-z0-9])?$"},"countryHint":{"type":"string","pattern":"^[A-Z]{2}$"},"country":{"type":"string","pattern":"^[A-Z]{2}$"}},"additionalProperties":false}},"required":["groupId","store"],"additionalProperties":false}}},"required":["storeCount","pageCount","storeSeries","storeDaily","undatedStores","rankTop3","rankFirst","markets","pixels","noPixelStores","options","related"],"additionalProperties":false}}}},"400":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"code":{"anyOf":[{"type":"string","enum":["validation","unauthenticated","scope_missing","forbidden","plan_required","email_unverified","not_found","conflict","limit_exceeded","rate_limited","row_budget_exhausted","refine_filters","upstream"]},{"type":"string","enum":["internal","timeout"]}]},"message":{"type":"string"},"details":{"type":"object","propertyNames":{"type":"string"},"additionalProperties":{}}},"required":["code","message"],"additionalProperties":false}},"required":["error"],"additionalProperties":false}}}},"401":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"code":{"anyOf":[{"type":"string","enum":["validation","unauthenticated","scope_missing","forbidden","plan_required","email_unverified","not_found","conflict","limit_exceeded","rate_limited","row_budget_exhausted","refine_filters","upstream"]},{"type":"string","enum":["internal","timeout"]}]},"message":{"type":"string"},"details":{"type":"object","propertyNames":{"type":"string"},"additionalProperties":{}}},"required":["code","message"],"additionalProperties":false}},"required":["error"],"additionalProperties":false}}}},"403":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"code":{"anyOf":[{"type":"string","enum":["validation","unauthenticated","scope_missing","forbidden","plan_required","email_unverified","not_found","conflict","limit_exceeded","rate_limited","row_budget_exhausted","refine_filters","upstream"]},{"type":"string","enum":["internal","timeout"]}]},"message":{"type":"string"},"details":{"type":"object","propertyNames":{"type":"string"},"additionalProperties":{}}},"required":["code","message"],"additionalProperties":false}},"required":["error"],"additionalProperties":false}}}},"404":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"code":{"anyOf":[{"type":"string","enum":["validation","unauthenticated","scope_missing","forbidden","plan_required","email_unverified","not_found","conflict","limit_exceeded","rate_limited","row_budget_exhausted","refine_filters","upstream"]},{"type":"string","enum":["internal","timeout"]}]},"message":{"type":"string"},"details":{"type":"object","propertyNames":{"type":"string"},"additionalProperties":{}}},"required":["code","message"],"additionalProperties":false}},"required":["error"],"additionalProperties":false}}}},"429":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"code":{"anyOf":[{"type":"string","enum":["validation","unauthenticated","scope_missing","forbidden","plan_required","email_unverified","not_found","conflict","limit_exceeded","rate_limited","row_budget_exhausted","refine_filters","upstream"]},{"type":"string","enum":["internal","timeout"]}]},"message":{"type":"string"},"details":{"type":"object","propertyNames":{"type":"string"},"additionalProperties":{}}},"required":["code","message"],"additionalProperties":false}},"required":["error"],"additionalProperties":false}}}}}}},"/v1/products/groups/{id}":{"get":{"operationId":"getProductsGroupsById","summary":"GET /v1/products/groups/{id} (products)","tags":["products"],"description":"GET /v1/products/groups/{id} (products). Signed-in: send `Authorization: Bearer <API key>` (keys are created at /account/api-keys).","parameters":[{"schema":{"type":"string","maxLength":2000},"in":"query","name":"country","required":false,"description":"Comma-separated list (20 distinct values at most); a store matches any of them (OR). Values are validated like a single value; duplicates and order are ignored."},{"schema":{"type":"string","maxLength":2000},"in":"query","name":"pixel","required":false,"description":"Comma-separated list (20 distinct values at most); a store matches any of them (OR). Values are validated like a single value; duplicates and order are ignored."},{"schema":{"type":"number","minimum":0},"in":"query","name":"priceMin","required":false},{"schema":{"type":"number","minimum":0},"in":"query","name":"priceMax","required":false},{"schema":{"type":"integer","minimum":1,"maximum":50},"in":"query","name":"rankMax","required":false,"description":"Only stores whose own best-selling sort puts the product this high"},{"schema":{"type":"string","format":"date-time","pattern":"^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d:[0-5]\\d(?:\\.\\d+)?(?:Z))$"},"in":"query","name":"addedSince","required":false,"description":"Only stores that added the product (Shopify creation time) since then"},{"schema":{"type":"string","format":"date-time","pattern":"^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d:[0-5]\\d(?:\\.\\d+)?(?:Z))$"},"in":"query","name":"foundedSince","required":false},{"schema":{"type":"integer","minimum":0,"maximum":9007199254740991},"in":"query","name":"visitsMin","required":false},{"schema":{"type":"string","enum":["signal","visits","rank","added","priceAsc","priceDesc","founded"]},"in":"query","name":"sort","required":false},{"schema":{"type":"string","pattern":"^[A-Za-z0-9_-]{2,400}$"},"in":"path","name":"id","required":true}],"responses":{"200":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"group":{"type":"object","properties":{"groupId":{"type":"string","pattern":"^[A-Za-z0-9_-]{2,400}$"},"title":{"type":"string"},"imageUrl":{"type":"string","format":"uri"},"storedImageUrl":{"description":"Roasan's stored copy of the main image (800 px WebP); prefer it to imageUrl","type":"string","format":"uri"},"match":{"type":"string","enum":["title_vendor","single","visual"]},"storeCount":{"type":"integer","minimum":0,"maximum":9007199254740991,"description":"Stores currently listing the same product (lower bound: only each store's newest products are observed). Not sales volume or revenue."},"storeCount7d":{"type":"integer","minimum":0,"maximum":9007199254740991,"description":"Stores that added the product to their newest products in the last 7 days"},"storeCount30d":{"type":"integer","minimum":0,"maximum":9007199254740991,"description":"Stores that added the product to their newest products in the last 30 days"},"priceUsdMin":{"type":"number","minimum":0},"priceUsdMax":{"type":"number","minimum":0},"niche":{"type":"string","enum":["animals-pet-supplies","apparel-accessories","arts-entertainment","baby-toddler","bundles","business-industrial","cameras-optics","electronics","food-beverages-tobacco","furniture","gift-cards","hardware","health-beauty","home-garden","luggage-bags","mature","media","office-supplies","product-add-ons","religious-ceremonial","services","software","sporting-goods","toys-games","uncategorized","vehicles-parts","other"]},"firstSeenAt":{"type":"string","format":"date-time","pattern":"^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d:[0-5]\\d(?:\\.\\d+)?(?:Z))$","description":"When Roasan first saw the product"},"countries":{"description":"Country hints of the listing stores, most stores first (at most 5)","maxItems":5,"type":"array","items":{"type":"string","minLength":2,"maxLength":2}},"countryCount":{"description":"Distinct countries of the listing stores (`countries` shows at most 5)","type":"integer","minimum":0,"maximum":9007199254740991},"similarity":{"description":"Image search only (23 §10): cosine of the best member image","type":"number","minimum":-1,"maximum":1},"store":{"description":"The group's representative store","type":"object","properties":{"handle":{"type":"string","minLength":1},"primaryDomain":{"type":"string","minLength":1}},"additionalProperties":false}},"required":["groupId","match","storeCount","storeCount7d","storeCount30d","firstSeenAt"],"additionalProperties":false},"stores":{"type":"array","items":{"type":"object","properties":{"handle":{"type":"string","minLength":1},"title":{"type":"string"},"imageUrl":{"type":"string","format":"uri"},"storedImageUrl":{"description":"Roasan's stored copy of the main image (800 px WebP); prefer it to imageUrl","type":"string","format":"uri"},"priceUsd":{"type":"number","minimum":0},"optionNames":{"description":"Product option names in order, e.g. [\"Color\", \"Size\"]","maxItems":3,"type":"array","items":{"type":"string","minLength":1}},"variantCount":{"type":"integer","minimum":0,"maximum":9007199254740991},"availableVariantCount":{"description":"Variants the store marks as available","type":"integer","minimum":0,"maximum":9007199254740991},"bundleMaxQty":{"description":"Largest bundle quantity sold as a variant (\"3 pack\")","type":"integer","minimum":2,"maximum":30000},"unitPriceUsd":{"description":"Lowest per-unit price in USD across bundle variants","type":"number","minimum":0},"rank":{"type":"integer","minimum":1,"maximum":50},"rankSource":{"type":"string","enum":["best_selling","catalog_order"]},"enteredTopAt":{"type":"string","format":"date-time","pattern":"^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d:[0-5]\\d(?:\\.\\d+)?(?:Z))$"},"productCreatedAt":{"type":"string","format":"date-time","pattern":"^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d:[0-5]\\d(?:\\.\\d+)?(?:Z))$"},"store":{"type":"object","properties":{"handle":{"description":"Canonical myshopify handle. Absent when unknown (headless stores); primaryDomain is then always present and serves as the store reference.","type":"string","maxLength":77,"pattern":"^[a-z0-9](?:[a-z0-9-]{0,61}[a-z0-9])?\\.myshopify\\.com$"},"primaryDomain":{"type":"string","maxLength":253,"pattern":"^(?:[a-z0-9](?:[a-z0-9-]{0,61}[a-z0-9])?\\.)+[a-z](?:[a-z0-9-]{0,61}[a-z0-9])?$"},"countryHint":{"type":"string","pattern":"^[A-Z]{2}$"},"country":{"type":"string","pattern":"^[A-Z]{2}$"}},"additionalProperties":false},"groupId":{"type":"string","pattern":"^[A-Za-z0-9_-]{2,400}$"},"storeCount":{"description":"Stores currently listing the same product (lower bound: only each store's newest products are observed). Not sales volume or revenue.","type":"integer","minimum":1,"maximum":9007199254740991},"signals":{"type":"object","properties":{"postPurchaseApps":{"description":"Post-purchase apps other than reviews (shipment tracking, returns, order status)","type":"integer","minimum":0,"maximum":9007199254740991},"hasReviewApp":{"type":"boolean"},"reviewCount":{"description":"Review total visible on the homepage; absent when no widget shows a count","type":"integer","minimum":0,"maximum":9007199254740991},"productsAdded30d":{"type":"integer","minimum":0,"maximum":9007199254740991},"copiedByStores":{"description":"Other stores that added this store's products later","type":"integer","minimum":0,"maximum":9007199254740991},"firstSeenAt":{"type":"string","format":"date-time","pattern":"^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d:[0-5]\\d(?:\\.\\d+)?(?:Z))$","description":"When Roasan first saw the store; not its launch date"}},"required":["firstSeenAt"],"additionalProperties":false},"storeName":{"type":"string","minLength":1},"faviconUrl":{"type":"string","format":"uri"},"currency":{"type":"string","minLength":3,"maxLength":3},"priceMin":{"type":"number","minimum":0},"compareAtMax":{"description":"Highest struck-through price, in the store currency","type":"number","minimum":0},"foundedAt":{"type":"string","format":"date-time","pattern":"^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d:[0-5]\\d(?:\\.\\d+)?(?:Z))$"},"monthlyVisits":{"description":"Estimated visits of the latest month with data (CrUX bucket)","type":"integer","minimum":0,"maximum":9007199254740991},"pixels":{"type":"array","items":{"type":"string","minLength":1}},"productCount":{"type":"integer","minimum":0,"maximum":9007199254740991}},"required":["handle","rank","rankSource","store"],"additionalProperties":false}},"matched":{"type":"integer","minimum":0,"maximum":9007199254740991}},"required":["group","stores"],"additionalProperties":false}}}},"400":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"code":{"anyOf":[{"type":"string","enum":["validation","unauthenticated","scope_missing","forbidden","plan_required","email_unverified","not_found","conflict","limit_exceeded","rate_limited","row_budget_exhausted","refine_filters","upstream"]},{"type":"string","enum":["internal","timeout"]}]},"message":{"type":"string"},"details":{"type":"object","propertyNames":{"type":"string"},"additionalProperties":{}}},"required":["code","message"],"additionalProperties":false}},"required":["error"],"additionalProperties":false}}}},"401":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"code":{"anyOf":[{"type":"string","enum":["validation","unauthenticated","scope_missing","forbidden","plan_required","email_unverified","not_found","conflict","limit_exceeded","rate_limited","row_budget_exhausted","refine_filters","upstream"]},{"type":"string","enum":["internal","timeout"]}]},"message":{"type":"string"},"details":{"type":"object","propertyNames":{"type":"string"},"additionalProperties":{}}},"required":["code","message"],"additionalProperties":false}},"required":["error"],"additionalProperties":false}}}},"403":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"code":{"anyOf":[{"type":"string","enum":["validation","unauthenticated","scope_missing","forbidden","plan_required","email_unverified","not_found","conflict","limit_exceeded","rate_limited","row_budget_exhausted","refine_filters","upstream"]},{"type":"string","enum":["internal","timeout"]}]},"message":{"type":"string"},"details":{"type":"object","propertyNames":{"type":"string"},"additionalProperties":{}}},"required":["code","message"],"additionalProperties":false}},"required":["error"],"additionalProperties":false}}}},"404":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"code":{"anyOf":[{"type":"string","enum":["validation","unauthenticated","scope_missing","forbidden","plan_required","email_unverified","not_found","conflict","limit_exceeded","rate_limited","row_budget_exhausted","refine_filters","upstream"]},{"type":"string","enum":["internal","timeout"]}]},"message":{"type":"string"},"details":{"type":"object","propertyNames":{"type":"string"},"additionalProperties":{}}},"required":["code","message"],"additionalProperties":false}},"required":["error"],"additionalProperties":false}}}},"429":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"code":{"anyOf":[{"type":"string","enum":["validation","unauthenticated","scope_missing","forbidden","plan_required","email_unverified","not_found","conflict","limit_exceeded","rate_limited","row_budget_exhausted","refine_filters","upstream"]},{"type":"string","enum":["internal","timeout"]}]},"message":{"type":"string"},"details":{"type":"object","propertyNames":{"type":"string"},"additionalProperties":{}}},"required":["code","message"],"additionalProperties":false}},"required":["error"],"additionalProperties":false}}}}}}},"/v1/stores/{ref}/products":{"get":{"operationId":"getStoresByRefProducts","summary":"GET /v1/stores/{ref}/products (products)","tags":["products"],"description":"GET /v1/stores/{ref}/products (products). Signed-in: send `Authorization: Bearer <API key>` (keys are created at /account/api-keys).","parameters":[{"schema":{"type":"string","minLength":1,"maxLength":253,"pattern":"^[A-Za-z0-9.-]+$"},"in":"path","name":"ref","required":true}],"responses":{"200":{"description":"Default Response","content":{"application/json":{"schema":{"type":"array","items":{"type":"object","properties":{"handle":{"type":"string","minLength":1},"title":{"type":"string"},"imageUrl":{"type":"string","format":"uri"},"storedImageUrl":{"description":"Roasan's stored copy of the main image (800 px WebP); prefer it to imageUrl","type":"string","format":"uri"},"priceUsd":{"type":"number","minimum":0},"optionNames":{"description":"Product option names in order, e.g. [\"Color\", \"Size\"]","maxItems":3,"type":"array","items":{"type":"string","minLength":1}},"variantCount":{"type":"integer","minimum":0,"maximum":9007199254740991},"availableVariantCount":{"description":"Variants the store marks as available","type":"integer","minimum":0,"maximum":9007199254740991},"bundleMaxQty":{"description":"Largest bundle quantity sold as a variant (\"3 pack\")","type":"integer","minimum":2,"maximum":30000},"unitPriceUsd":{"description":"Lowest per-unit price in USD across bundle variants","type":"number","minimum":0},"rank":{"type":"integer","minimum":1,"maximum":50},"rankSource":{"type":"string","enum":["best_selling","catalog_order"]},"enteredTopAt":{"type":"string","format":"date-time","pattern":"^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d:[0-5]\\d(?:\\.\\d+)?(?:Z))$"},"productCreatedAt":{"type":"string","format":"date-time","pattern":"^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d:[0-5]\\d(?:\\.\\d+)?(?:Z))$"},"store":{"type":"object","properties":{"handle":{"description":"Canonical myshopify handle. Absent when unknown (headless stores); primaryDomain is then always present and serves as the store reference.","type":"string","maxLength":77,"pattern":"^[a-z0-9](?:[a-z0-9-]{0,61}[a-z0-9])?\\.myshopify\\.com$"},"primaryDomain":{"type":"string","maxLength":253,"pattern":"^(?:[a-z0-9](?:[a-z0-9-]{0,61}[a-z0-9])?\\.)+[a-z](?:[a-z0-9-]{0,61}[a-z0-9])?$"},"countryHint":{"type":"string","pattern":"^[A-Z]{2}$"},"country":{"type":"string","pattern":"^[A-Z]{2}$"}},"additionalProperties":false},"groupId":{"type":"string","pattern":"^[A-Za-z0-9_-]{2,400}$"},"storeCount":{"description":"Stores currently listing the same product (lower bound: only each store's newest products are observed). Not sales volume or revenue.","type":"integer","minimum":1,"maximum":9007199254740991}},"required":["handle","rank","rankSource","store"],"additionalProperties":false}}}}},"400":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"code":{"anyOf":[{"type":"string","enum":["validation","unauthenticated","scope_missing","forbidden","plan_required","email_unverified","not_found","conflict","limit_exceeded","rate_limited","row_budget_exhausted","refine_filters","upstream"]},{"type":"string","enum":["internal","timeout"]}]},"message":{"type":"string"},"details":{"type":"object","propertyNames":{"type":"string"},"additionalProperties":{}}},"required":["code","message"],"additionalProperties":false}},"required":["error"],"additionalProperties":false}}}},"401":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"code":{"anyOf":[{"type":"string","enum":["validation","unauthenticated","scope_missing","forbidden","plan_required","email_unverified","not_found","conflict","limit_exceeded","rate_limited","row_budget_exhausted","refine_filters","upstream"]},{"type":"string","enum":["internal","timeout"]}]},"message":{"type":"string"},"details":{"type":"object","propertyNames":{"type":"string"},"additionalProperties":{}}},"required":["code","message"],"additionalProperties":false}},"required":["error"],"additionalProperties":false}}}},"403":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"code":{"anyOf":[{"type":"string","enum":["validation","unauthenticated","scope_missing","forbidden","plan_required","email_unverified","not_found","conflict","limit_exceeded","rate_limited","row_budget_exhausted","refine_filters","upstream"]},{"type":"string","enum":["internal","timeout"]}]},"message":{"type":"string"},"details":{"type":"object","propertyNames":{"type":"string"},"additionalProperties":{}}},"required":["code","message"],"additionalProperties":false}},"required":["error"],"additionalProperties":false}}}},"404":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"code":{"anyOf":[{"type":"string","enum":["validation","unauthenticated","scope_missing","forbidden","plan_required","email_unverified","not_found","conflict","limit_exceeded","rate_limited","row_budget_exhausted","refine_filters","upstream"]},{"type":"string","enum":["internal","timeout"]}]},"message":{"type":"string"},"details":{"type":"object","propertyNames":{"type":"string"},"additionalProperties":{}}},"required":["code","message"],"additionalProperties":false}},"required":["error"],"additionalProperties":false}}}},"429":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"code":{"anyOf":[{"type":"string","enum":["validation","unauthenticated","scope_missing","forbidden","plan_required","email_unverified","not_found","conflict","limit_exceeded","rate_limited","row_budget_exhausted","refine_filters","upstream"]},{"type":"string","enum":["internal","timeout"]}]},"message":{"type":"string"},"details":{"type":"object","propertyNames":{"type":"string"},"additionalProperties":{}}},"required":["code","message"],"additionalProperties":false}},"required":["error"],"additionalProperties":false}}}}}}},"/v1/niches":{"get":{"operationId":"getNiches","summary":"GET /v1/niches (niches)","tags":["niches"],"description":"GET /v1/niches (niches). Signed-in: send `Authorization: Bearer <API key>` (keys are created at /account/api-keys).","responses":{"200":{"description":"Default Response","content":{"application/json":{"schema":{"type":"array","items":{"type":"object","properties":{"slug":{"type":"string","enum":["animals-pet-supplies","apparel-accessories","arts-entertainment","baby-toddler","bundles","business-industrial","cameras-optics","electronics","food-beverages-tobacco","furniture","gift-cards","hardware","health-beauty","home-garden","luggage-bags","mature","media","office-supplies","product-add-ons","religious-ceremonial","services","software","sporting-goods","toys-games","uncategorized","vehicles-parts","other","dog-supplies","cat-supplies","aquarium-fish","small-pets-birds-reptiles","pet-home-travel","pet-apparel","pet-health-grooming","everyday-clothing","streetwear","graphic-tees","activewear","lingerie-underwear","swimwear","sleepwear-loungewear","modest-fashion","ethnic-traditional-wear","maternity-wear","outerwear","workwear-uniforms","sneakers","shoes-boots","fine-jewelry","fashion-jewelry","body-jewelry","watches","handbags-wallets","hats-caps","eyewear","fashion-accessories","costumes-cosplay","art-supplies","craft-kits","knitting-sewing","stickers-decals","trading-cards","collectibles-memorabilia","model-kits-hobby","musical-instruments","party-supplies","gift-wrap-cards","flowers-bouquets","event-tickets","baby-feeding","baby-gear","baby-care","baby-toys","nursery","product-bundles","salon-beauty-pro","tattoo-piercing-supplies","medical-dental-pro","food-service-equipment","packaging-shipping","signage-neon","promotional-merch","industrial-equipment","cameras-photography","binoculars-optics","phone-accessories","phones-tablets","chargers-cables","audio-headphones","pro-audio-dj","gaming-gear","computer-accessories","wearable-tech","smart-home","tv-projectors","drones","three-d-printing","electronic-components","coffee","tea","snacks","candy-chocolate","sauces-spices","pantry-fresh-food","alcoholic-beverages","functional-drinks","cbd-hemp","vape-tobacco","living-dining-furniture","bedroom-mattresses","office-furniture","outdoor-furniture","storage-furniture","gift-cards-vouchers","tools","home-improvement","solar-portable-power","knives-edc","skincare","makeup","nail-care","hair-care","wigs-hair-extensions","fragrance","bath-body","mens-grooming","beauty-devices","oral-care","supplements","sports-nutrition","home-health","pain-relief-orthopedic","massage-relaxation","feminine-care","candles-home-fragrance","wall-art-prints","home-decor","rugs-curtains","bedding-linens","seasonal-decor","kitchen-gadgets","cookware-bakeware","kitchen-appliances","bbq-grilling","drinkware-tableware","lighting","home-organization","cleaning-laundry","climate-air","gardening","plants-seeds","outdoor-living","pool-spa","home-security","backpacks-everyday-bags","travel-luggage","sexual-wellness","weapons-tactical","books-magazines","music-recordings","courses-coaching","stationery","office-equipment","shipping-protection","service-add-ons","wedding","religious-items","spiritual-metaphysical","memorial","service-listings","digital-products","software-apps","virtual-currency","fitness-equipment","yoga-pilates","camping-hiking","fishing","hunting","golf","cycling","water-sports","winter-sports","skate-scooters","team-sports","racket-sports","combat-sports","equestrian","game-room","board-games","collectible-figures","plush-toys","dolls-pretend-play","building-toys","educational-toys","rc-vehicles","outdoor-play","fidget-sensory-toys","car-accessories","car-care-detailing","auto-parts","motorcycle-gear","e-mobility","offroad-overlanding","marine-boating","vehicles-for-sale"]},"nameTr":{"type":"string","minLength":1},"nameEn":{"type":"string","minLength":1},"level":{"anyOf":[{"type":"number","enum":[1]},{"type":"number","enum":[2]}],"description":"1 = main category, 2 = niche under `parent` (taxonomy v2)"},"parent":{"description":"Main category of a level-2 niche","type":"string","enum":["animals-pet-supplies","apparel-accessories","arts-entertainment","baby-toddler","bundles","business-industrial","cameras-optics","electronics","food-beverages-tobacco","furniture","gift-cards","hardware","health-beauty","home-garden","luggage-bags","mature","media","office-supplies","product-add-ons","religious-ceremonial","services","software","sporting-goods","toys-games","uncategorized","vehicles-parts","other"]},"stats":{"type":"object","properties":{"storeCount":{"type":"integer","minimum":0,"maximum":9007199254740991,"description":"Active stores of the niche"},"newStores30d":{"type":"integer","minimum":0,"maximum":9007199254740991,"description":"Active stores of the niche Roasan first saw in the 30 days before computedAt"},"growth":{"type":"object","properties":{"storeCounts":{"maxItems":12,"type":"array","items":{"type":"integer","minimum":0,"maximum":9007199254740991},"description":"Active stores at the end of each of the last weeks, oldest first"},"changePct":{"type":"number","description":"Change in percent; absent without a base"}},"required":["storeCounts"],"additionalProperties":false},"medianPriceUsd":{"type":"number","minimum":0},"risingProduct":{"description":"The niche product most stores added in the last 7 days","type":"object","properties":{"groupId":{"type":"string","pattern":"^[A-Za-z0-9_-]{2,400}$"},"title":{"type":"string"},"imageUrl":{"type":"string","format":"uri"},"storeCount7d":{"type":"integer","minimum":0,"maximum":9007199254740991},"storeCount":{"type":"integer","minimum":0,"maximum":9007199254740991}},"required":["groupId","storeCount7d","storeCount"],"additionalProperties":false},"topApp":{"type":"object","properties":{"appClientId":{"type":"string","minLength":1},"name":{"type":"string","minLength":1},"share":{"type":"number","minimum":0,"maximum":100,"description":"Percentage (0–100) of the niche stores where the value is known"}},"required":["appClientId","share"],"additionalProperties":false},"topTheme":{"type":"object","properties":{"name":{"type":"string","minLength":1},"share":{"type":"number","minimum":0,"maximum":100,"description":"Percentage (0–100) of the niche stores where the value is known"}},"required":["name","share"],"additionalProperties":false},"topCountries":{"maxItems":3,"type":"array","items":{"type":"string","pattern":"^[A-Z]{2}$"}},"computedAt":{"type":"string","format":"date-time","pattern":"^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d:[0-5]\\d(?:\\.\\d+)?(?:Z))$"}},"required":["storeCount","newStores30d","growth","topCountries","computedAt"],"additionalProperties":false}},"required":["slug","nameTr","nameEn","level"],"additionalProperties":false}}}}},"401":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"code":{"anyOf":[{"type":"string","enum":["validation","unauthenticated","scope_missing","forbidden","plan_required","email_unverified","not_found","conflict","limit_exceeded","rate_limited","row_budget_exhausted","refine_filters","upstream"]},{"type":"string","enum":["internal","timeout"]}]},"message":{"type":"string"},"details":{"type":"object","propertyNames":{"type":"string"},"additionalProperties":{}}},"required":["code","message"],"additionalProperties":false}},"required":["error"],"additionalProperties":false}}}},"403":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"code":{"anyOf":[{"type":"string","enum":["validation","unauthenticated","scope_missing","forbidden","plan_required","email_unverified","not_found","conflict","limit_exceeded","rate_limited","row_budget_exhausted","refine_filters","upstream"]},{"type":"string","enum":["internal","timeout"]}]},"message":{"type":"string"},"details":{"type":"object","propertyNames":{"type":"string"},"additionalProperties":{}}},"required":["code","message"],"additionalProperties":false}},"required":["error"],"additionalProperties":false}}}},"429":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"code":{"anyOf":[{"type":"string","enum":["validation","unauthenticated","scope_missing","forbidden","plan_required","email_unverified","not_found","conflict","limit_exceeded","rate_limited","row_budget_exhausted","refine_filters","upstream"]},{"type":"string","enum":["internal","timeout"]}]},"message":{"type":"string"},"details":{"type":"object","propertyNames":{"type":"string"},"additionalProperties":{}}},"required":["code","message"],"additionalProperties":false}},"required":["error"],"additionalProperties":false}}}}}}},"/v1/niches/{slug}":{"get":{"operationId":"getNichesBySlug","summary":"GET /v1/niches/{slug} (niches)","tags":["niches"],"description":"GET /v1/niches/{slug} (niches). Signed-in: send `Authorization: Bearer <API key>` (keys are created at /account/api-keys).","parameters":[{"schema":{"default":"true","type":"string","enum":["true","false"]},"in":"query","name":"rising","required":false},{"schema":{"type":"string","minLength":1,"maxLength":64},"in":"path","name":"slug","required":true}],"responses":{"200":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"slug":{"type":"string","enum":["animals-pet-supplies","apparel-accessories","arts-entertainment","baby-toddler","bundles","business-industrial","cameras-optics","electronics","food-beverages-tobacco","furniture","gift-cards","hardware","health-beauty","home-garden","luggage-bags","mature","media","office-supplies","product-add-ons","religious-ceremonial","services","software","sporting-goods","toys-games","uncategorized","vehicles-parts","other","dog-supplies","cat-supplies","aquarium-fish","small-pets-birds-reptiles","pet-home-travel","pet-apparel","pet-health-grooming","everyday-clothing","streetwear","graphic-tees","activewear","lingerie-underwear","swimwear","sleepwear-loungewear","modest-fashion","ethnic-traditional-wear","maternity-wear","outerwear","workwear-uniforms","sneakers","shoes-boots","fine-jewelry","fashion-jewelry","body-jewelry","watches","handbags-wallets","hats-caps","eyewear","fashion-accessories","costumes-cosplay","art-supplies","craft-kits","knitting-sewing","stickers-decals","trading-cards","collectibles-memorabilia","model-kits-hobby","musical-instruments","party-supplies","gift-wrap-cards","flowers-bouquets","event-tickets","baby-feeding","baby-gear","baby-care","baby-toys","nursery","product-bundles","salon-beauty-pro","tattoo-piercing-supplies","medical-dental-pro","food-service-equipment","packaging-shipping","signage-neon","promotional-merch","industrial-equipment","cameras-photography","binoculars-optics","phone-accessories","phones-tablets","chargers-cables","audio-headphones","pro-audio-dj","gaming-gear","computer-accessories","wearable-tech","smart-home","tv-projectors","drones","three-d-printing","electronic-components","coffee","tea","snacks","candy-chocolate","sauces-spices","pantry-fresh-food","alcoholic-beverages","functional-drinks","cbd-hemp","vape-tobacco","living-dining-furniture","bedroom-mattresses","office-furniture","outdoor-furniture","storage-furniture","gift-cards-vouchers","tools","home-improvement","solar-portable-power","knives-edc","skincare","makeup","nail-care","hair-care","wigs-hair-extensions","fragrance","bath-body","mens-grooming","beauty-devices","oral-care","supplements","sports-nutrition","home-health","pain-relief-orthopedic","massage-relaxation","feminine-care","candles-home-fragrance","wall-art-prints","home-decor","rugs-curtains","bedding-linens","seasonal-decor","kitchen-gadgets","cookware-bakeware","kitchen-appliances","bbq-grilling","drinkware-tableware","lighting","home-organization","cleaning-laundry","climate-air","gardening","plants-seeds","outdoor-living","pool-spa","home-security","backpacks-everyday-bags","travel-luggage","sexual-wellness","weapons-tactical","books-magazines","music-recordings","courses-coaching","stationery","office-equipment","shipping-protection","service-add-ons","wedding","religious-items","spiritual-metaphysical","memorial","service-listings","digital-products","software-apps","virtual-currency","fitness-equipment","yoga-pilates","camping-hiking","fishing","hunting","golf","cycling","water-sports","winter-sports","skate-scooters","team-sports","racket-sports","combat-sports","equestrian","game-room","board-games","collectible-figures","plush-toys","dolls-pretend-play","building-toys","educational-toys","rc-vehicles","outdoor-play","fidget-sensory-toys","car-accessories","car-care-detailing","auto-parts","motorcycle-gear","e-mobility","offroad-overlanding","marine-boating","vehicles-for-sale"]},"nameTr":{"type":"string","minLength":1},"nameEn":{"type":"string","minLength":1},"level":{"anyOf":[{"type":"number","enum":[1]},{"type":"number","enum":[2]}],"description":"1 = main category, 2 = niche under `parent` (taxonomy v2)"},"parent":{"description":"Main category of a level-2 niche","type":"string","enum":["animals-pet-supplies","apparel-accessories","arts-entertainment","baby-toddler","bundles","business-industrial","cameras-optics","electronics","food-beverages-tobacco","furniture","gift-cards","hardware","health-beauty","home-garden","luggage-bags","mature","media","office-supplies","product-add-ons","religious-ceremonial","services","software","sporting-goods","toys-games","uncategorized","vehicles-parts","other"]},"stats":{"type":"object","properties":{"storeCount":{"type":"integer","minimum":0,"maximum":9007199254740991,"description":"Active stores of the niche"},"newStores30d":{"type":"integer","minimum":0,"maximum":9007199254740991,"description":"Active stores of the niche Roasan first saw in the 30 days before computedAt"},"newStoresPrev30d":{"type":"integer","minimum":0,"maximum":9007199254740991,"description":"Stores first seen 60–30 days before computedAt"},"storeCountChangePct":{"description":"Change of the store count over the last 30 days, in percent","type":"number"},"weekly":{"maxItems":52,"type":"array","items":{"type":"object","properties":{"weekEnd":{"type":"string","format":"date","pattern":"^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))$","description":"Last UTC day of the week"},"newStores":{"type":"integer","minimum":0,"maximum":9007199254740991},"storeCount":{"type":"integer","minimum":0,"maximum":9007199254740991}},"required":["weekEnd","newStores","storeCount"],"additionalProperties":false}},"countries":{"type":"array","items":{"type":"object","properties":{"country":{"type":"string","pattern":"^[A-Z]{2}$"},"storeCount":{"type":"integer","minimum":0,"maximum":9007199254740991},"share":{"type":"number","minimum":0,"maximum":100,"description":"Percentage (0–100) of the niche stores where the value is known"}},"required":["country","storeCount","share"],"additionalProperties":false}},"currencies":{"type":"array","items":{"type":"object","properties":{"currency":{"type":"string","pattern":"^[A-Z]{3}$"},"storeCount":{"type":"integer","minimum":0,"maximum":9007199254740991},"share":{"type":"number","minimum":0,"maximum":100,"description":"Percentage (0–100) of the niche stores where the value is known"}},"required":["currency","storeCount","share"],"additionalProperties":false}},"topApps":{"type":"array","items":{"type":"object","properties":{"appClientId":{"type":"string","minLength":1},"name":{"type":"string","minLength":1},"storeCount":{"type":"integer","minimum":0,"maximum":9007199254740991},"share":{"type":"number","minimum":0,"maximum":100,"description":"Percentage (0–100) of the niche stores where the value is known"}},"required":["appClientId","storeCount","share"],"additionalProperties":false}},"pixels":{"type":"array","items":{"type":"object","properties":{"platform":{"type":"string","minLength":1},"storeCount":{"type":"integer","minimum":0,"maximum":9007199254740991},"share":{"type":"number","minimum":0,"maximum":100,"description":"Percentage (0–100) of the niche stores where the value is known"}},"required":["platform","storeCount","share"],"additionalProperties":false}},"topThemes":{"type":"array","items":{"type":"object","properties":{"name":{"type":"string","minLength":1},"storeCount":{"type":"integer","minimum":0,"maximum":9007199254740991},"share":{"type":"number","minimum":0,"maximum":100,"description":"Percentage (0–100) of the niche stores where the value is known"}},"required":["name","storeCount","share"],"additionalProperties":false}},"customTheme":{"description":"Stores on a theme name almost no other store uses","type":"object","properties":{"storeCount":{"type":"integer","minimum":0,"maximum":9007199254740991},"share":{"type":"number","minimum":0,"maximum":100,"description":"Percentage (0–100) of the niche stores where the value is known"}},"required":["storeCount","share"],"additionalProperties":false},"priceUsd":{"type":"object","properties":{"pricedProducts":{"type":"integer","minimum":0,"maximum":9007199254740991},"p25":{"type":"number","minimum":0},"p50":{"type":"number","minimum":0},"p75":{"type":"number","minimum":0},"histogram":{"type":"array","items":{"type":"object","properties":{"minUsd":{"type":"number","minimum":0},"maxUsd":{"type":"number","exclusiveMinimum":0},"products":{"type":"integer","minimum":0,"maximum":9007199254740991}},"required":["minUsd","products"],"additionalProperties":false}}},"required":["pricedProducts","histogram"],"additionalProperties":false},"profile":{"type":"object","properties":{"medianProductCount":{"type":"integer","minimum":0,"maximum":9007199254740991},"medianAppCount":{"type":"number","minimum":0},"medianDiscountedShare":{"type":"number","minimum":0,"maximum":100,"description":"Percentage (0–100) of the niche stores where the value is known"},"medianSoldOutShare":{"type":"number","minimum":0,"maximum":100,"description":"Percentage (0–100) of the niche stores where the value is known"},"shopPayShare":{"type":"number","minimum":0,"maximum":100,"description":"Percentage (0–100) of the niche stores where the value is known"},"reviewAppShare":{"type":"number","minimum":0,"maximum":100,"description":"Percentage (0–100) of the niche stores where the value is known"},"medianStoreAgeDays":{"type":"integer","minimum":0,"maximum":9007199254740991}},"additionalProperties":false},"productGroups":{"type":"object","properties":{"count":{"type":"integer","minimum":0,"maximum":9007199254740991},"new30d":{"type":"integer","minimum":0,"maximum":9007199254740991}},"required":["count","new30d"],"additionalProperties":false},"computedAt":{"type":"string","format":"date-time","pattern":"^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d:[0-5]\\d(?:\\.\\d+)?(?:Z))$"}},"required":["storeCount","newStores30d","newStoresPrev30d","weekly","countries","currencies","topApps","pixels","topThemes","priceUsd","profile","productGroups","computedAt"],"additionalProperties":false},"risingProducts":{"maxItems":6,"type":"array","items":{"type":"object","properties":{"groupId":{"type":"string","pattern":"^[A-Za-z0-9_-]{2,400}$"},"title":{"type":"string"},"imageUrl":{"type":"string","format":"uri"},"storedImageUrl":{"description":"Roasan's stored copy of the main image (800 px WebP); prefer it to imageUrl","type":"string","format":"uri"},"match":{"type":"string","enum":["title_vendor","single","visual"]},"storeCount":{"type":"integer","minimum":0,"maximum":9007199254740991,"description":"Stores currently listing the same product (lower bound: only each store's newest products are observed). Not sales volume or revenue."},"storeCount7d":{"type":"integer","minimum":0,"maximum":9007199254740991,"description":"Stores that added the product to their newest products in the last 7 days"},"storeCount30d":{"type":"integer","minimum":0,"maximum":9007199254740991,"description":"Stores that added the product to their newest products in the last 30 days"},"priceUsdMin":{"type":"number","minimum":0},"priceUsdMax":{"type":"number","minimum":0},"niche":{"type":"string","enum":["animals-pet-supplies","apparel-accessories","arts-entertainment","baby-toddler","bundles","business-industrial","cameras-optics","electronics","food-beverages-tobacco","furniture","gift-cards","hardware","health-beauty","home-garden","luggage-bags","mature","media","office-supplies","product-add-ons","religious-ceremonial","services","software","sporting-goods","toys-games","uncategorized","vehicles-parts","other"]},"firstSeenAt":{"type":"string","format":"date-time","pattern":"^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d:[0-5]\\d(?:\\.\\d+)?(?:Z))$","description":"When Roasan first saw the product"},"countries":{"description":"Country hints of the listing stores, most stores first (at most 5)","maxItems":5,"type":"array","items":{"type":"string","minLength":2,"maxLength":2}},"countryCount":{"description":"Distinct countries of the listing stores (`countries` shows at most 5)","type":"integer","minimum":0,"maximum":9007199254740991},"similarity":{"description":"Image search only (23 §10): cosine of the best member image","type":"number","minimum":-1,"maximum":1},"store":{"description":"The group's representative store","type":"object","properties":{"handle":{"type":"string","minLength":1},"primaryDomain":{"type":"string","minLength":1}},"additionalProperties":false},"days":{"type":"array","items":{"type":"integer","minimum":0,"maximum":9007199254740991},"description":"Stores that added the product on each of the last 7 UTC days, oldest first"}},"required":["groupId","match","storeCount","storeCount7d","storeCount30d","firstSeenAt","days"],"additionalProperties":false}}},"required":["slug","nameTr","nameEn","level","risingProducts"],"additionalProperties":false}}}},"401":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"code":{"anyOf":[{"type":"string","enum":["validation","unauthenticated","scope_missing","forbidden","plan_required","email_unverified","not_found","conflict","limit_exceeded","rate_limited","row_budget_exhausted","refine_filters","upstream"]},{"type":"string","enum":["internal","timeout"]}]},"message":{"type":"string"},"details":{"type":"object","propertyNames":{"type":"string"},"additionalProperties":{}}},"required":["code","message"],"additionalProperties":false}},"required":["error"],"additionalProperties":false}}}},"403":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"code":{"anyOf":[{"type":"string","enum":["validation","unauthenticated","scope_missing","forbidden","plan_required","email_unverified","not_found","conflict","limit_exceeded","rate_limited","row_budget_exhausted","refine_filters","upstream"]},{"type":"string","enum":["internal","timeout"]}]},"message":{"type":"string"},"details":{"type":"object","propertyNames":{"type":"string"},"additionalProperties":{}}},"required":["code","message"],"additionalProperties":false}},"required":["error"],"additionalProperties":false}}}},"404":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"code":{"anyOf":[{"type":"string","enum":["validation","unauthenticated","scope_missing","forbidden","plan_required","email_unverified","not_found","conflict","limit_exceeded","rate_limited","row_budget_exhausted","refine_filters","upstream"]},{"type":"string","enum":["internal","timeout"]}]},"message":{"type":"string"},"details":{"type":"object","propertyNames":{"type":"string"},"additionalProperties":{}}},"required":["code","message"],"additionalProperties":false}},"required":["error"],"additionalProperties":false}}}},"429":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"code":{"anyOf":[{"type":"string","enum":["validation","unauthenticated","scope_missing","forbidden","plan_required","email_unverified","not_found","conflict","limit_exceeded","rate_limited","row_budget_exhausted","refine_filters","upstream"]},{"type":"string","enum":["internal","timeout"]}]},"message":{"type":"string"},"details":{"type":"object","propertyNames":{"type":"string"},"additionalProperties":{}}},"required":["code","message"],"additionalProperties":false}},"required":["error"],"additionalProperties":false}}}}}}},"/v1/niches/{slug}/rising":{"get":{"operationId":"getNichesBySlugRising","summary":"GET /v1/niches/{slug}/rising (niches)","tags":["niches"],"description":"GET /v1/niches/{slug}/rising (niches). Signed-in: send `Authorization: Bearer <API key>` (keys are created at /account/api-keys).","parameters":[{"schema":{"type":"string","minLength":1,"maxLength":64},"in":"path","name":"slug","required":true}],"responses":{"200":{"description":"Default Response","content":{"application/json":{"schema":{"maxItems":6,"type":"array","items":{"type":"object","properties":{"groupId":{"type":"string","pattern":"^[A-Za-z0-9_-]{2,400}$"},"title":{"type":"string"},"imageUrl":{"type":"string","format":"uri"},"storedImageUrl":{"description":"Roasan's stored copy of the main image (800 px WebP); prefer it to imageUrl","type":"string","format":"uri"},"match":{"type":"string","enum":["title_vendor","single","visual"]},"storeCount":{"type":"integer","minimum":0,"maximum":9007199254740991,"description":"Stores currently listing the same product (lower bound: only each store's newest products are observed). Not sales volume or revenue."},"storeCount7d":{"type":"integer","minimum":0,"maximum":9007199254740991,"description":"Stores that added the product to their newest products in the last 7 days"},"storeCount30d":{"type":"integer","minimum":0,"maximum":9007199254740991,"description":"Stores that added the product to their newest products in the last 30 days"},"priceUsdMin":{"type":"number","minimum":0},"priceUsdMax":{"type":"number","minimum":0},"niche":{"type":"string","enum":["animals-pet-supplies","apparel-accessories","arts-entertainment","baby-toddler","bundles","business-industrial","cameras-optics","electronics","food-beverages-tobacco","furniture","gift-cards","hardware","health-beauty","home-garden","luggage-bags","mature","media","office-supplies","product-add-ons","religious-ceremonial","services","software","sporting-goods","toys-games","uncategorized","vehicles-parts","other"]},"firstSeenAt":{"type":"string","format":"date-time","pattern":"^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d:[0-5]\\d(?:\\.\\d+)?(?:Z))$","description":"When Roasan first saw the product"},"countries":{"description":"Country hints of the listing stores, most stores first (at most 5)","maxItems":5,"type":"array","items":{"type":"string","minLength":2,"maxLength":2}},"countryCount":{"description":"Distinct countries of the listing stores (`countries` shows at most 5)","type":"integer","minimum":0,"maximum":9007199254740991},"similarity":{"description":"Image search only (23 §10): cosine of the best member image","type":"number","minimum":-1,"maximum":1},"store":{"description":"The group's representative store","type":"object","properties":{"handle":{"type":"string","minLength":1},"primaryDomain":{"type":"string","minLength":1}},"additionalProperties":false},"days":{"type":"array","items":{"type":"integer","minimum":0,"maximum":9007199254740991},"description":"Stores that added the product on each of the last 7 UTC days, oldest first"}},"required":["groupId","match","storeCount","storeCount7d","storeCount30d","firstSeenAt","days"],"additionalProperties":false}}}}},"401":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"code":{"anyOf":[{"type":"string","enum":["validation","unauthenticated","scope_missing","forbidden","plan_required","email_unverified","not_found","conflict","limit_exceeded","rate_limited","row_budget_exhausted","refine_filters","upstream"]},{"type":"string","enum":["internal","timeout"]}]},"message":{"type":"string"},"details":{"type":"object","propertyNames":{"type":"string"},"additionalProperties":{}}},"required":["code","message"],"additionalProperties":false}},"required":["error"],"additionalProperties":false}}}},"403":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"code":{"anyOf":[{"type":"string","enum":["validation","unauthenticated","scope_missing","forbidden","plan_required","email_unverified","not_found","conflict","limit_exceeded","rate_limited","row_budget_exhausted","refine_filters","upstream"]},{"type":"string","enum":["internal","timeout"]}]},"message":{"type":"string"},"details":{"type":"object","propertyNames":{"type":"string"},"additionalProperties":{}}},"required":["code","message"],"additionalProperties":false}},"required":["error"],"additionalProperties":false}}}},"404":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"code":{"anyOf":[{"type":"string","enum":["validation","unauthenticated","scope_missing","forbidden","plan_required","email_unverified","not_found","conflict","limit_exceeded","rate_limited","row_budget_exhausted","refine_filters","upstream"]},{"type":"string","enum":["internal","timeout"]}]},"message":{"type":"string"},"details":{"type":"object","propertyNames":{"type":"string"},"additionalProperties":{}}},"required":["code","message"],"additionalProperties":false}},"required":["error"],"additionalProperties":false}}}},"429":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"code":{"anyOf":[{"type":"string","enum":["validation","unauthenticated","scope_missing","forbidden","plan_required","email_unverified","not_found","conflict","limit_exceeded","rate_limited","row_budget_exhausted","refine_filters","upstream"]},{"type":"string","enum":["internal","timeout"]}]},"message":{"type":"string"},"details":{"type":"object","propertyNames":{"type":"string"},"additionalProperties":{}}},"required":["code","message"],"additionalProperties":false}},"required":["error"],"additionalProperties":false}}}}}}},"/v1/apps":{"get":{"operationId":"getApps","summary":"GET /v1/apps (apps)","tags":["apps"],"description":"GET /v1/apps (apps). Signed-in: send `Authorization: Bearer <API key>` (keys are created at /account/api-keys).","parameters":[{"schema":{"type":"string","minLength":1,"maxLength":100},"in":"query","name":"q","required":false},{"schema":{"default":"false","type":"string","enum":["true","false"]},"in":"query","name":"named","required":false},{"schema":{"default":"false","type":"string","enum":["true","false"]},"in":"query","name":"listed","required":false},{"schema":{"type":"string","minLength":1,"maxLength":512},"in":"query","name":"cursor","required":false},{"schema":{"default":20,"type":"integer","minimum":1,"maximum":50},"in":"query","name":"limit","required":false}],"responses":{"200":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"items":{"maxItems":50,"type":"array","items":{"type":"object","properties":{"id":{"type":"string","maxLength":19,"pattern":"^[1-9][0-9]*$"},"name":{"type":"string","minLength":1},"vendor":{"type":"string","minLength":1},"iconUrl":{"type":"string","format":"uri"},"storeCount":{"type":"integer","minimum":0,"maximum":9007199254740991},"firstSeenAt":{"type":"string","format":"date-time","pattern":"^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d:[0-5]\\d(?:\\.\\d+)?(?:Z))$"}},"required":["id","storeCount","firstSeenAt"],"additionalProperties":false}},"nextCursor":{"anyOf":[{"type":"string","minLength":1},{"type":"null"}]}},"required":["items","nextCursor"],"additionalProperties":false}}}},"400":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"code":{"anyOf":[{"type":"string","enum":["validation","unauthenticated","scope_missing","forbidden","plan_required","email_unverified","not_found","conflict","limit_exceeded","rate_limited","row_budget_exhausted","refine_filters","upstream"]},{"type":"string","enum":["internal","timeout"]}]},"message":{"type":"string"},"details":{"type":"object","propertyNames":{"type":"string"},"additionalProperties":{}}},"required":["code","message"],"additionalProperties":false}},"required":["error"],"additionalProperties":false}}}},"401":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"code":{"anyOf":[{"type":"string","enum":["validation","unauthenticated","scope_missing","forbidden","plan_required","email_unverified","not_found","conflict","limit_exceeded","rate_limited","row_budget_exhausted","refine_filters","upstream"]},{"type":"string","enum":["internal","timeout"]}]},"message":{"type":"string"},"details":{"type":"object","propertyNames":{"type":"string"},"additionalProperties":{}}},"required":["code","message"],"additionalProperties":false}},"required":["error"],"additionalProperties":false}}}},"403":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"code":{"anyOf":[{"type":"string","enum":["validation","unauthenticated","scope_missing","forbidden","plan_required","email_unverified","not_found","conflict","limit_exceeded","rate_limited","row_budget_exhausted","refine_filters","upstream"]},{"type":"string","enum":["internal","timeout"]}]},"message":{"type":"string"},"details":{"type":"object","propertyNames":{"type":"string"},"additionalProperties":{}}},"required":["code","message"],"additionalProperties":false}},"required":["error"],"additionalProperties":false}}}},"404":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"code":{"anyOf":[{"type":"string","enum":["validation","unauthenticated","scope_missing","forbidden","plan_required","email_unverified","not_found","conflict","limit_exceeded","rate_limited","row_budget_exhausted","refine_filters","upstream"]},{"type":"string","enum":["internal","timeout"]}]},"message":{"type":"string"},"details":{"type":"object","propertyNames":{"type":"string"},"additionalProperties":{}}},"required":["code","message"],"additionalProperties":false}},"required":["error"],"additionalProperties":false}}}},"429":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"code":{"anyOf":[{"type":"string","enum":["validation","unauthenticated","scope_missing","forbidden","plan_required","email_unverified","not_found","conflict","limit_exceeded","rate_limited","row_budget_exhausted","refine_filters","upstream"]},{"type":"string","enum":["internal","timeout"]}]},"message":{"type":"string"},"details":{"type":"object","propertyNames":{"type":"string"},"additionalProperties":{}}},"required":["code","message"],"additionalProperties":false}},"required":["error"],"additionalProperties":false}}}}}}},"/v1/apps/{id}":{"get":{"operationId":"getAppsById","summary":"GET /v1/apps/{id} (apps)","tags":["apps"],"description":"GET /v1/apps/{id} (apps). Signed-in: send `Authorization: Bearer <API key>` (keys are created at /account/api-keys).","parameters":[{"schema":{"type":"string","maxLength":19,"pattern":"^[1-9][0-9]*$"},"in":"path","name":"id","required":true}],"responses":{"200":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"id":{"type":"string","maxLength":19,"pattern":"^[1-9][0-9]*$"},"name":{"type":"string","minLength":1},"vendor":{"type":"string","minLength":1},"iconUrl":{"type":"string","format":"uri"},"storeCount":{"type":"integer","minimum":0,"maximum":9007199254740991},"firstSeenAt":{"type":"string","format":"date-time","pattern":"^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d:[0-5]\\d(?:\\.\\d+)?(?:Z))$"}},"required":["id","storeCount","firstSeenAt"],"additionalProperties":false}}}},"400":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"code":{"anyOf":[{"type":"string","enum":["validation","unauthenticated","scope_missing","forbidden","plan_required","email_unverified","not_found","conflict","limit_exceeded","rate_limited","row_budget_exhausted","refine_filters","upstream"]},{"type":"string","enum":["internal","timeout"]}]},"message":{"type":"string"},"details":{"type":"object","propertyNames":{"type":"string"},"additionalProperties":{}}},"required":["code","message"],"additionalProperties":false}},"required":["error"],"additionalProperties":false}}}},"401":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"code":{"anyOf":[{"type":"string","enum":["validation","unauthenticated","scope_missing","forbidden","plan_required","email_unverified","not_found","conflict","limit_exceeded","rate_limited","row_budget_exhausted","refine_filters","upstream"]},{"type":"string","enum":["internal","timeout"]}]},"message":{"type":"string"},"details":{"type":"object","propertyNames":{"type":"string"},"additionalProperties":{}}},"required":["code","message"],"additionalProperties":false}},"required":["error"],"additionalProperties":false}}}},"403":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"code":{"anyOf":[{"type":"string","enum":["validation","unauthenticated","scope_missing","forbidden","plan_required","email_unverified","not_found","conflict","limit_exceeded","rate_limited","row_budget_exhausted","refine_filters","upstream"]},{"type":"string","enum":["internal","timeout"]}]},"message":{"type":"string"},"details":{"type":"object","propertyNames":{"type":"string"},"additionalProperties":{}}},"required":["code","message"],"additionalProperties":false}},"required":["error"],"additionalProperties":false}}}},"404":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"code":{"anyOf":[{"type":"string","enum":["validation","unauthenticated","scope_missing","forbidden","plan_required","email_unverified","not_found","conflict","limit_exceeded","rate_limited","row_budget_exhausted","refine_filters","upstream"]},{"type":"string","enum":["internal","timeout"]}]},"message":{"type":"string"},"details":{"type":"object","propertyNames":{"type":"string"},"additionalProperties":{}}},"required":["code","message"],"additionalProperties":false}},"required":["error"],"additionalProperties":false}}}},"429":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"code":{"anyOf":[{"type":"string","enum":["validation","unauthenticated","scope_missing","forbidden","plan_required","email_unverified","not_found","conflict","limit_exceeded","rate_limited","row_budget_exhausted","refine_filters","upstream"]},{"type":"string","enum":["internal","timeout"]}]},"message":{"type":"string"},"details":{"type":"object","propertyNames":{"type":"string"},"additionalProperties":{}}},"required":["code","message"],"additionalProperties":false}},"required":["error"],"additionalProperties":false}}}}}}},"/v1/apps/{id}/stores":{"get":{"operationId":"getAppsByIdStores","summary":"GET /v1/apps/{id}/stores (apps)","tags":["apps"],"description":"GET /v1/apps/{id}/stores (apps). Signed-in: send `Authorization: Bearer <API key>` (keys are created at /account/api-keys).","parameters":[{"schema":{"type":"string","minLength":1,"maxLength":512},"in":"query","name":"cursor","required":false},{"schema":{"default":20,"type":"integer","minimum":1,"maximum":50},"in":"query","name":"limit","required":false},{"schema":{"type":"string","maxLength":19,"pattern":"^[1-9][0-9]*$"},"in":"path","name":"id","required":true}],"responses":{"200":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"items":{"maxItems":50,"type":"array","items":{"type":"object","properties":{"handle":{"description":"Canonical myshopify handle. Absent when unknown (headless stores); primaryDomain is then always present and serves as the store reference.","type":"string","maxLength":77,"pattern":"^[a-z0-9](?:[a-z0-9-]{0,61}[a-z0-9])?\\.myshopify\\.com$"},"primaryDomain":{"type":"string","maxLength":253,"pattern":"^(?:[a-z0-9](?:[a-z0-9-]{0,61}[a-z0-9])?\\.)+[a-z](?:[a-z0-9-]{0,61}[a-z0-9])?$"},"status":{"type":"string","enum":["active","password_protected","unreachable","not_shopify_anymore"]},"isHeadless":{"type":"boolean"},"theme":{"type":"object","properties":{"id":{"type":"string","minLength":1},"name":{"type":"string","minLength":1}},"additionalProperties":false},"productCount":{"type":"integer","minimum":0,"maximum":9007199254740991},"currency":{"type":"string","pattern":"^[A-Z]{3}$"},"locale":{"type":"string","maxLength":35,"pattern":"^[a-z]{2,3}(?:-[A-Za-z0-9]{2,8})*$"},"countryHint":{"type":"string","pattern":"^[A-Z]{2}$"},"country":{"type":"string","pattern":"^[A-Z]{2}$"},"contact":{"type":"object","properties":{"kind":{"type":"string","enum":["non_personal","personal"]},"email":{"type":"string","format":"email","pattern":"^(?:[A-Za-z0-9_'+\\-]+\\.)*[A-Za-z0-9_'+\\-]*[A-Za-z0-9_+-]@(?:[A-Za-z0-9][A-Za-z0-9\\-]*\\.)+[A-Za-z]{2,}$"},"phone":{"type":"string","pattern":"^\\+[1-9][0-9]{7,14}$"}},"required":["kind"],"additionalProperties":false},"foundedAt":{"type":"string","format":"date-time","pattern":"^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d:[0-5]\\d(?:\\.\\d+)?(?:Z))$"},"foundedPrecision":{"type":"string","enum":["day","month"]},"firstSeenAt":{"type":"string","format":"date-time","pattern":"^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d:[0-5]\\d(?:\\.\\d+)?(?:Z))$"},"preview":{"oneOf":[{"type":"object","properties":{"kind":{"type":"string","enum":["mosaic"]},"tiles":{"minItems":1,"maxItems":4,"type":"array","items":{"type":"string","format":"uri"}}},"required":["kind","tiles"],"additionalProperties":false},{"type":"object","properties":{"kind":{"type":"string","enum":["screenshot"]},"url":{"type":"string","format":"uri"},"thumbUrl":{"type":"string","format":"uri"},"tiles":{"minItems":1,"maxItems":4,"type":"array","items":{"type":"string","format":"uri"}}},"required":["kind","url"],"additionalProperties":false}]},"traffic":{"description":"Estimated monthly visits (latest finished month). confidence none = under ~1K; low carries a range instead of a figure; null = not measured yet.","anyOf":[{"type":"object","properties":{"month":{"type":"string","pattern":"^\\d{4}-\\d{2}$"},"confidence":{"type":"string","enum":["high","medium","low","none"]},"visits":{"anyOf":[{"type":"integer","minimum":0,"maximum":9007199254740991},{"type":"null"}]},"range":{"anyOf":[{"type":"object","properties":{"low":{"type":"integer","minimum":0,"maximum":9007199254740991},"high":{"type":"integer","minimum":0,"maximum":9007199254740991}},"required":["low","high"],"additionalProperties":false},{"type":"null"}]}},"required":["month","confidence","visits","range"],"additionalProperties":false},{"type":"null"}]},"signals":{"type":"object","properties":{"postPurchaseApps":{"description":"Post-purchase apps other than reviews (shipment tracking, returns, order status)","type":"integer","minimum":0,"maximum":9007199254740991},"hasReviewApp":{"type":"boolean"},"reviewCount":{"description":"Review total visible on the homepage; absent when no widget shows a count","type":"integer","minimum":0,"maximum":9007199254740991},"productsAdded30d":{"type":"integer","minimum":0,"maximum":9007199254740991},"copiedByStores":{"description":"Other stores that added this store's products later","type":"integer","minimum":0,"maximum":9007199254740991},"firstSeenAt":{"type":"string","format":"date-time","pattern":"^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d:[0-5]\\d(?:\\.\\d+)?(?:Z))$","description":"When Roasan first saw the store; not its launch date"}},"required":["firstSeenAt"],"additionalProperties":false},"appCount":{"type":"integer","minimum":0,"maximum":9007199254740991},"appLogos":{"maxItems":3,"type":"array","items":{"type":"object","properties":{"name":{"type":"string","minLength":1},"iconUrl":{"type":"string","format":"uri"}},"required":["name","iconUrl"],"additionalProperties":false}},"productTiles":{"maxItems":3,"type":"array","items":{"type":"object","properties":{"imageUrl":{"type":"string","format":"uri"},"title":{"type":"string","maxLength":500},"price":{"type":"string","pattern":"^\\d{1,10}(\\.\\d{1,2})?$"}},"required":["imageUrl","title"],"additionalProperties":false}},"trafficSpark":{"maxItems":12,"type":"array","items":{"anyOf":[{"type":"integer","minimum":0,"maximum":9007199254740991},{"type":"null"}]}},"businessCountry":{"type":"string","pattern":"^[A-Z]{2}$"},"topCountries":{"maxItems":3,"type":"array","items":{"type":"string","pattern":"^[A-Z]{2}$"}}},"required":["status","isHeadless","firstSeenAt"],"additionalProperties":false}},"nextCursor":{"anyOf":[{"type":"string","minLength":1},{"type":"null"}]}},"required":["items","nextCursor"],"additionalProperties":false}}}},"400":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"code":{"anyOf":[{"type":"string","enum":["validation","unauthenticated","scope_missing","forbidden","plan_required","email_unverified","not_found","conflict","limit_exceeded","rate_limited","row_budget_exhausted","refine_filters","upstream"]},{"type":"string","enum":["internal","timeout"]}]},"message":{"type":"string"},"details":{"type":"object","propertyNames":{"type":"string"},"additionalProperties":{}}},"required":["code","message"],"additionalProperties":false}},"required":["error"],"additionalProperties":false}}}},"401":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"code":{"anyOf":[{"type":"string","enum":["validation","unauthenticated","scope_missing","forbidden","plan_required","email_unverified","not_found","conflict","limit_exceeded","rate_limited","row_budget_exhausted","refine_filters","upstream"]},{"type":"string","enum":["internal","timeout"]}]},"message":{"type":"string"},"details":{"type":"object","propertyNames":{"type":"string"},"additionalProperties":{}}},"required":["code","message"],"additionalProperties":false}},"required":["error"],"additionalProperties":false}}}},"403":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"code":{"anyOf":[{"type":"string","enum":["validation","unauthenticated","scope_missing","forbidden","plan_required","email_unverified","not_found","conflict","limit_exceeded","rate_limited","row_budget_exhausted","refine_filters","upstream"]},{"type":"string","enum":["internal","timeout"]}]},"message":{"type":"string"},"details":{"type":"object","propertyNames":{"type":"string"},"additionalProperties":{}}},"required":["code","message"],"additionalProperties":false}},"required":["error"],"additionalProperties":false}}}},"404":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"code":{"anyOf":[{"type":"string","enum":["validation","unauthenticated","scope_missing","forbidden","plan_required","email_unverified","not_found","conflict","limit_exceeded","rate_limited","row_budget_exhausted","refine_filters","upstream"]},{"type":"string","enum":["internal","timeout"]}]},"message":{"type":"string"},"details":{"type":"object","propertyNames":{"type":"string"},"additionalProperties":{}}},"required":["code","message"],"additionalProperties":false}},"required":["error"],"additionalProperties":false}}}},"429":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"code":{"anyOf":[{"type":"string","enum":["validation","unauthenticated","scope_missing","forbidden","plan_required","email_unverified","not_found","conflict","limit_exceeded","rate_limited","row_budget_exhausted","refine_filters","upstream"]},{"type":"string","enum":["internal","timeout"]}]},"message":{"type":"string"},"details":{"type":"object","propertyNames":{"type":"string"},"additionalProperties":{}}},"required":["code","message"],"additionalProperties":false}},"required":["error"],"additionalProperties":false}}}}}}},"/v1/themes":{"get":{"operationId":"getThemes","summary":"GET /v1/themes (themes)","tags":["themes"],"description":"GET /v1/themes (themes). Signed-in: send `Authorization: Bearer <API key>` (keys are created at /account/api-keys).","parameters":[{"schema":{"type":"string","minLength":1,"maxLength":100},"in":"query","name":"q","required":false},{"schema":{"type":"string","minLength":1,"maxLength":512},"in":"query","name":"cursor","required":false},{"schema":{"default":20,"type":"integer","minimum":1,"maximum":50},"in":"query","name":"limit","required":false}],"responses":{"200":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"items":{"maxItems":50,"type":"array","items":{"type":"object","properties":{"id":{"type":"string","minLength":1,"maxLength":200},"name":{"type":"string","minLength":1,"maxLength":200},"storeCount":{"type":"integer","minimum":0,"maximum":9007199254740991}},"required":["id","name","storeCount"],"additionalProperties":false}},"nextCursor":{"anyOf":[{"type":"string","minLength":1},{"type":"null"}]}},"required":["items","nextCursor"],"additionalProperties":false}}}},"400":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"code":{"anyOf":[{"type":"string","enum":["validation","unauthenticated","scope_missing","forbidden","plan_required","email_unverified","not_found","conflict","limit_exceeded","rate_limited","row_budget_exhausted","refine_filters","upstream"]},{"type":"string","enum":["internal","timeout"]}]},"message":{"type":"string"},"details":{"type":"object","propertyNames":{"type":"string"},"additionalProperties":{}}},"required":["code","message"],"additionalProperties":false}},"required":["error"],"additionalProperties":false}}}},"401":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"code":{"anyOf":[{"type":"string","enum":["validation","unauthenticated","scope_missing","forbidden","plan_required","email_unverified","not_found","conflict","limit_exceeded","rate_limited","row_budget_exhausted","refine_filters","upstream"]},{"type":"string","enum":["internal","timeout"]}]},"message":{"type":"string"},"details":{"type":"object","propertyNames":{"type":"string"},"additionalProperties":{}}},"required":["code","message"],"additionalProperties":false}},"required":["error"],"additionalProperties":false}}}},"403":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"code":{"anyOf":[{"type":"string","enum":["validation","unauthenticated","scope_missing","forbidden","plan_required","email_unverified","not_found","conflict","limit_exceeded","rate_limited","row_budget_exhausted","refine_filters","upstream"]},{"type":"string","enum":["internal","timeout"]}]},"message":{"type":"string"},"details":{"type":"object","propertyNames":{"type":"string"},"additionalProperties":{}}},"required":["code","message"],"additionalProperties":false}},"required":["error"],"additionalProperties":false}}}},"404":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"code":{"anyOf":[{"type":"string","enum":["validation","unauthenticated","scope_missing","forbidden","plan_required","email_unverified","not_found","conflict","limit_exceeded","rate_limited","row_budget_exhausted","refine_filters","upstream"]},{"type":"string","enum":["internal","timeout"]}]},"message":{"type":"string"},"details":{"type":"object","propertyNames":{"type":"string"},"additionalProperties":{}}},"required":["code","message"],"additionalProperties":false}},"required":["error"],"additionalProperties":false}}}},"429":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"code":{"anyOf":[{"type":"string","enum":["validation","unauthenticated","scope_missing","forbidden","plan_required","email_unverified","not_found","conflict","limit_exceeded","rate_limited","row_budget_exhausted","refine_filters","upstream"]},{"type":"string","enum":["internal","timeout"]}]},"message":{"type":"string"},"details":{"type":"object","propertyNames":{"type":"string"},"additionalProperties":{}}},"required":["code","message"],"additionalProperties":false}},"required":["error"],"additionalProperties":false}}}}}}},"/v1/themes/{id}":{"get":{"operationId":"getThemesById","summary":"GET /v1/themes/{id} (themes)","tags":["themes"],"description":"GET /v1/themes/{id} (themes). Signed-in: send `Authorization: Bearer <API key>` (keys are created at /account/api-keys).","parameters":[{"schema":{"type":"string","minLength":1,"maxLength":200},"in":"path","name":"id","required":true}],"responses":{"200":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"id":{"type":"string","minLength":1,"maxLength":200},"name":{"type":"string","minLength":1,"maxLength":200},"storeCount":{"type":"integer","minimum":0,"maximum":9007199254740991}},"required":["id","name","storeCount"],"additionalProperties":false}}}},"400":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"code":{"anyOf":[{"type":"string","enum":["validation","unauthenticated","scope_missing","forbidden","plan_required","email_unverified","not_found","conflict","limit_exceeded","rate_limited","row_budget_exhausted","refine_filters","upstream"]},{"type":"string","enum":["internal","timeout"]}]},"message":{"type":"string"},"details":{"type":"object","propertyNames":{"type":"string"},"additionalProperties":{}}},"required":["code","message"],"additionalProperties":false}},"required":["error"],"additionalProperties":false}}}},"401":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"code":{"anyOf":[{"type":"string","enum":["validation","unauthenticated","scope_missing","forbidden","plan_required","email_unverified","not_found","conflict","limit_exceeded","rate_limited","row_budget_exhausted","refine_filters","upstream"]},{"type":"string","enum":["internal","timeout"]}]},"message":{"type":"string"},"details":{"type":"object","propertyNames":{"type":"string"},"additionalProperties":{}}},"required":["code","message"],"additionalProperties":false}},"required":["error"],"additionalProperties":false}}}},"403":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"code":{"anyOf":[{"type":"string","enum":["validation","unauthenticated","scope_missing","forbidden","plan_required","email_unverified","not_found","conflict","limit_exceeded","rate_limited","row_budget_exhausted","refine_filters","upstream"]},{"type":"string","enum":["internal","timeout"]}]},"message":{"type":"string"},"details":{"type":"object","propertyNames":{"type":"string"},"additionalProperties":{}}},"required":["code","message"],"additionalProperties":false}},"required":["error"],"additionalProperties":false}}}},"404":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"code":{"anyOf":[{"type":"string","enum":["validation","unauthenticated","scope_missing","forbidden","plan_required","email_unverified","not_found","conflict","limit_exceeded","rate_limited","row_budget_exhausted","refine_filters","upstream"]},{"type":"string","enum":["internal","timeout"]}]},"message":{"type":"string"},"details":{"type":"object","propertyNames":{"type":"string"},"additionalProperties":{}}},"required":["code","message"],"additionalProperties":false}},"required":["error"],"additionalProperties":false}}}},"429":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"code":{"anyOf":[{"type":"string","enum":["validation","unauthenticated","scope_missing","forbidden","plan_required","email_unverified","not_found","conflict","limit_exceeded","rate_limited","row_budget_exhausted","refine_filters","upstream"]},{"type":"string","enum":["internal","timeout"]}]},"message":{"type":"string"},"details":{"type":"object","propertyNames":{"type":"string"},"additionalProperties":{}}},"required":["code","message"],"additionalProperties":false}},"required":["error"],"additionalProperties":false}}}}}}},"/v1/stores/lookup":{"get":{"operationId":"getStoresLookup","summary":"GET /v1/stores/lookup (stores)","tags":["stores"],"description":"GET /v1/stores/lookup (stores). Signed-in: send `Authorization: Bearer <API key>` (keys are created at /account/api-keys).","parameters":[{"schema":{"type":"string","minLength":1,"maxLength":253},"in":"query","name":"domain","required":true}],"responses":{"200":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"storeId":{"type":"string","maxLength":19,"pattern":"^[1-9][0-9]*$"},"handle":{"description":"Canonical myshopify handle. Absent when unknown (headless stores); primaryDomain is then always present and serves as the store reference.","type":"string","maxLength":77,"pattern":"^[a-z0-9](?:[a-z0-9-]{0,61}[a-z0-9])?\\.myshopify\\.com$"},"shopId":{"type":"string","maxLength":19,"pattern":"^[1-9][0-9]*$"},"primaryDomain":{"type":"string","maxLength":253,"pattern":"^(?:[a-z0-9](?:[a-z0-9-]{0,61}[a-z0-9])?\\.)+[a-z](?:[a-z0-9-]{0,61}[a-z0-9])?$"},"status":{"type":"string","enum":["active","password_protected","unreachable","not_shopify_anymore"]},"isHeadless":{"type":"boolean"},"theme":{"type":"object","properties":{"id":{"type":"string","minLength":1},"name":{"type":"string","minLength":1}},"additionalProperties":false},"productCount":{"type":"integer","minimum":0,"maximum":9007199254740991},"currency":{"type":"string","pattern":"^[A-Z]{3}$"},"locale":{"type":"string","maxLength":35,"pattern":"^[a-z]{2,3}(?:-[A-Za-z0-9]{2,8})*$"},"countryHint":{"type":"string","pattern":"^[A-Z]{2}$"},"country":{"type":"string","pattern":"^[A-Z]{2}$"},"contact":{"type":"object","properties":{"kind":{"type":"string","enum":["non_personal","personal"]},"email":{"type":"string","format":"email","pattern":"^(?:[A-Za-z0-9_'+\\-]+\\.)*[A-Za-z0-9_'+\\-]*[A-Za-z0-9_+-]@(?:[A-Za-z0-9][A-Za-z0-9\\-]*\\.)+[A-Za-z]{2,}$"},"phone":{"type":"string","pattern":"^\\+[1-9][0-9]{7,14}$"}},"required":["kind"],"additionalProperties":false},"isSoleProprietor":{"type":"boolean"},"foundedAt":{"type":"string","format":"date-time","pattern":"^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d:[0-5]\\d(?:\\.\\d+)?(?:Z))$"},"foundedPrecision":{"type":"string","enum":["day","month"]},"firstSeenAt":{"type":"string","format":"date-time","pattern":"^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d:[0-5]\\d(?:\\.\\d+)?(?:Z))$"},"preview":{"oneOf":[{"type":"object","properties":{"kind":{"type":"string","enum":["mosaic"]},"tiles":{"minItems":1,"maxItems":4,"type":"array","items":{"type":"string","format":"uri"}}},"required":["kind","tiles"],"additionalProperties":false},{"type":"object","properties":{"kind":{"type":"string","enum":["screenshot"]},"url":{"type":"string","format":"uri"},"thumbUrl":{"type":"string","format":"uri"},"tiles":{"minItems":1,"maxItems":4,"type":"array","items":{"type":"string","format":"uri"}}},"required":["kind","url"],"additionalProperties":false}]},"pixels":{"description":"Ad and analytics platforms the storefront reports to, by name (e.g. meta, tiktok, google_ads, ga4, gtm, pinterest, snapchat, x, reddit, microsoft_ads, klaviyo). Never an account id.","maxItems":32,"type":"array","items":{"type":"string","minLength":1,"maxLength":32}},"storeName":{"type":"string","minLength":1,"maxLength":255},"faviconUrl":{"type":"string","format":"uri"},"category":{"type":"string","minLength":1,"maxLength":64},"secondCategory":{"type":"string","minLength":1,"maxLength":64},"niche":{"type":"string","minLength":1,"maxLength":64},"secondNiche":{"type":"string","minLength":1,"maxLength":64},"tags":{"maxItems":64,"type":"array","items":{"type":"string","minLength":1,"maxLength":64}},"businessAddress":{"type":"object","properties":{"city":{"type":"string","minLength":1,"maxLength":255},"province":{"type":"string","minLength":1,"maxLength":255},"country":{"type":"string","pattern":"^[A-Z]{2}$"}},"additionalProperties":false},"socialPlatforms":{"maxItems":32,"type":"array","items":{"type":"string","minLength":1,"maxLength":32}},"shipsToCount":{"type":"integer","minimum":0,"maximum":9007199254740991},"shopPayInstallments":{"type":"boolean"},"signals":{"type":"object","properties":{"postPurchaseApps":{"description":"Post-purchase apps other than reviews (shipment tracking, returns, order status)","type":"integer","minimum":0,"maximum":9007199254740991},"hasReviewApp":{"type":"boolean"},"reviewCount":{"description":"Review total visible on the homepage; absent when no widget shows a count","type":"integer","minimum":0,"maximum":9007199254740991},"productsAdded30d":{"type":"integer","minimum":0,"maximum":9007199254740991},"copiedByStores":{"description":"Other stores that added this store's products later","type":"integer","minimum":0,"maximum":9007199254740991},"firstSeenAt":{"type":"string","format":"date-time","pattern":"^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d:[0-5]\\d(?:\\.\\d+)?(?:Z))$","description":"When Roasan first saw the store; not its launch date"}},"required":["firstSeenAt"],"additionalProperties":false},"catalog":{"type":"object","properties":{"discountedShare":{"type":"integer","minimum":0,"maximum":100},"soldOutShare":{"type":"integer","minimum":0,"maximum":100},"vendorCount":{"type":"integer","minimum":0,"maximum":9007199254740991},"newProductImages30d":{"type":"integer","minimum":0,"maximum":9007199254740991}},"additionalProperties":false},"traffic":{"description":"Estimated monthly visits (latest finished month). confidence none = under ~1K; low carries a range instead of a figure; null = not measured yet.","anyOf":[{"type":"object","properties":{"month":{"type":"string","pattern":"^\\d{4}-\\d{2}$"},"confidence":{"type":"string","enum":["high","medium","low","none"]},"visits":{"anyOf":[{"type":"integer","minimum":0,"maximum":9007199254740991},{"type":"null"}]},"range":{"anyOf":[{"type":"object","properties":{"low":{"type":"integer","minimum":0,"maximum":9007199254740991},"high":{"type":"integer","minimum":0,"maximum":9007199254740991}},"required":["low","high"],"additionalProperties":false},{"type":"null"}]}},"required":["month","confidence","visits","range"],"additionalProperties":false},{"type":"null"}]}},"required":["storeId","status","isHeadless","isSoleProprietor","firstSeenAt"],"additionalProperties":false}}}},"202":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"queued":{"type":"boolean","enum":[true]}},"required":["queued"],"additionalProperties":false}}}},"400":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"code":{"anyOf":[{"type":"string","enum":["validation","unauthenticated","scope_missing","forbidden","plan_required","email_unverified","not_found","conflict","limit_exceeded","rate_limited","row_budget_exhausted","refine_filters","upstream"]},{"type":"string","enum":["internal","timeout"]}]},"message":{"type":"string"},"details":{"type":"object","propertyNames":{"type":"string"},"additionalProperties":{}}},"required":["code","message"],"additionalProperties":false}},"required":["error"],"additionalProperties":false}}}},"401":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"code":{"anyOf":[{"type":"string","enum":["validation","unauthenticated","scope_missing","forbidden","plan_required","email_unverified","not_found","conflict","limit_exceeded","rate_limited","row_budget_exhausted","refine_filters","upstream"]},{"type":"string","enum":["internal","timeout"]}]},"message":{"type":"string"},"details":{"type":"object","propertyNames":{"type":"string"},"additionalProperties":{}}},"required":["code","message"],"additionalProperties":false}},"required":["error"],"additionalProperties":false}}}},"403":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"code":{"anyOf":[{"type":"string","enum":["validation","unauthenticated","scope_missing","forbidden","plan_required","email_unverified","not_found","conflict","limit_exceeded","rate_limited","row_budget_exhausted","refine_filters","upstream"]},{"type":"string","enum":["internal","timeout"]}]},"message":{"type":"string"},"details":{"type":"object","propertyNames":{"type":"string"},"additionalProperties":{}}},"required":["code","message"],"additionalProperties":false}},"required":["error"],"additionalProperties":false}}}},"404":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"code":{"anyOf":[{"type":"string","enum":["validation","unauthenticated","scope_missing","forbidden","plan_required","email_unverified","not_found","conflict","limit_exceeded","rate_limited","row_budget_exhausted","refine_filters","upstream"]},{"type":"string","enum":["internal","timeout"]}]},"message":{"type":"string"},"details":{"type":"object","propertyNames":{"type":"string"},"additionalProperties":{}}},"required":["code","message"],"additionalProperties":false}},"required":["error"],"additionalProperties":false}}}},"429":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"code":{"anyOf":[{"type":"string","enum":["validation","unauthenticated","scope_missing","forbidden","plan_required","email_unverified","not_found","conflict","limit_exceeded","rate_limited","row_budget_exhausted","refine_filters","upstream"]},{"type":"string","enum":["internal","timeout"]}]},"message":{"type":"string"},"details":{"type":"object","propertyNames":{"type":"string"},"additionalProperties":{}}},"required":["code","message"],"additionalProperties":false}},"required":["error"],"additionalProperties":false}}}}}}},"/v1/suppression":{"post":{"operationId":"postSuppression","summary":"POST /v1/suppression (suppression)","tags":["suppression"],"description":"POST /v1/suppression (suppression). Signed-in: send `Authorization: Bearer <API key>` (keys are created at /account/api-keys).","requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"domain":{"type":"string","minLength":1,"maxLength":253},"email":{"type":"string","maxLength":320,"format":"email","pattern":"^(?:[A-Za-z0-9_'+\\-]+\\.)*[A-Za-z0-9_'+\\-]*[A-Za-z0-9_+-]@(?:[A-Za-z0-9][A-Za-z0-9\\-]*\\.)+[A-Za-z]{2,}$"},"reason":{"type":"string","minLength":1,"maxLength":500},"kind":{"default":"opt_out","type":"string","enum":["opt_out","dsar_access","dsar_delete"]}},"required":["domain","email"]}}}},"responses":{"202":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"status":{"type":"string","enum":["accepted"]}},"required":["status"],"additionalProperties":false}}}},"400":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"code":{"anyOf":[{"type":"string","enum":["validation","unauthenticated","scope_missing","forbidden","plan_required","email_unverified","not_found","conflict","limit_exceeded","rate_limited","row_budget_exhausted","refine_filters","upstream"]},{"type":"string","enum":["internal","timeout"]}]},"message":{"type":"string"},"details":{"type":"object","propertyNames":{"type":"string"},"additionalProperties":{}}},"required":["code","message"],"additionalProperties":false}},"required":["error"],"additionalProperties":false}}}},"429":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"code":{"anyOf":[{"type":"string","enum":["validation","unauthenticated","scope_missing","forbidden","plan_required","email_unverified","not_found","conflict","limit_exceeded","rate_limited","row_budget_exhausted","refine_filters","upstream"]},{"type":"string","enum":["internal","timeout"]}]},"message":{"type":"string"},"details":{"type":"object","propertyNames":{"type":"string"},"additionalProperties":{}}},"required":["code","message"],"additionalProperties":false}},"required":["error"],"additionalProperties":false}}}}}}}},"servers":[{"url":"https://roasan.com","description":"Roasan public API"}]}