{"openapi":"3.0.3","info":{"title":"Trackee API","description":"Trackee public API","version":"0.1.0"},"components":{"securitySchemes":{"accessKey":{"type":"apiKey","in":"header","name":"x-access-key"}},"schemas":{}},"paths":{"/v1/health":{"get":{"operationId":"healthCheck","summary":"Health check","tags":["Health"],"responses":{"200":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","additionalProperties":false,"required":["ok"],"properties":{"ok":{"type":"boolean","enum":[true]}}}}}}}}},"/v1/health/auth":{"get":{"operationId":"healthCheckAuth","summary":"Verify that the provided access key is valid","tags":["Health"],"security":[{"accessKey":[]}],"responses":{"200":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","additionalProperties":false,"required":["ok"],"properties":{"ok":{"type":"boolean","enum":[true]}}}}}}}}},"/v1/usage/":{"get":{"operationId":"getUsage","summary":"Get credit usage","tags":["Usage"],"description":"Returns daily and monthly credit history plus the current balance for the authenticated organization.","parameters":[{"schema":{"type":"string","pattern":"^\\d{4}-(0[1-9]|1[0-2])$"},"in":"query","name":"from","required":false,"description":"Inclusive start month (YYYY-MM)."},{"schema":{"type":"string","pattern":"^\\d{4}-(0[1-9]|1[0-2])$"},"in":"query","name":"to","required":false,"description":"Inclusive end month (YYYY-MM)."},{"schema":{"type":"integer","minimum":1,"maximum":90,"default":30},"in":"query","name":"days","required":false,"description":"Number of recent UTC days to return."}],"security":[{"accessKey":[]}],"responses":{"200":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","additionalProperties":false,"required":["success","totalUsage","usage","dailyUsage","balance"],"properties":{"success":{"type":"boolean","enum":[true]},"totalUsage":{"type":"integer","minimum":0,"description":"All-time credits used."},"usage":{"type":"array","description":"Monthly credit history, oldest first.","items":{"type":"object","additionalProperties":false,"required":["year","month","count","platform"],"properties":{"year":{"type":"integer"},"month":{"type":"integer","minimum":1,"maximum":12},"count":{"type":"integer","minimum":0},"platform":{"type":"object","additionalProperties":{"type":"integer","minimum":0},"description":"Credits by platform. Empty until platform usage is attributed."}}}},"dailyUsage":{"type":"array","description":"Daily credit history, oldest first, including zero days.","items":{"type":"object","additionalProperties":false,"required":["date","count","monthly","purchased"],"properties":{"date":{"type":"string","format":"date"},"count":{"type":"integer","minimum":0},"monthly":{"type":"integer","minimum":0},"purchased":{"type":"integer","minimum":0}}}},"balance":{"type":"object","additionalProperties":false,"required":["monthly","purchased"],"properties":{"monthly":{"type":"object","additionalProperties":false,"required":["limit","used","remaining","cycleStart","cycleEnd"],"properties":{"limit":{"type":"integer","minimum":0},"used":{"type":"integer","minimum":0},"remaining":{"type":"integer","minimum":0},"cycleStart":{"type":"string","format":"date-time"},"cycleEnd":{"type":"string","format":"date-time"}}},"purchased":{"type":"object","additionalProperties":false,"required":["total","used","remaining"],"properties":{"total":{"type":"integer","minimum":0},"used":{"type":"integer","minimum":0},"remaining":{"type":"integer","minimum":0}}}}}}}}}},"400":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","additionalProperties":false,"required":["success","message"],"properties":{"success":{"type":"boolean","enum":[false]},"message":{"type":"string"}}}}}},"401":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","additionalProperties":false,"required":["success","message"],"properties":{"success":{"type":"boolean","enum":[false]},"message":{"type":"string"}}}}}},"403":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","additionalProperties":false,"required":["success","message"],"properties":{"success":{"type":"boolean","enum":[false]},"message":{"type":"string"}}}}}}}}},"/v1/brands/":{"post":{"operationId":"createBrand","summary":"Create a brand to track","tags":["Brands"],"description":"Creates a brand: the entity you track across Google and AI models. Stores its aliases, tracked engines, prompts, and competitors. Free, no credits.","requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","additionalProperties":false,"required":["name"],"properties":{"name":{"type":"string","minLength":1,"maxLength":200},"domain":{"type":"string","maxLength":253},"aliases":{"type":"array","items":{"type":"string","minLength":1},"maxItems":25},"category":{"type":"string","maxLength":100},"location":{"type":"string","minLength":1},"engines":{"type":"array","items":{"type":"string","enum":["chatgpt","claude","gemini","perplexity"]},"uniqueItems":true,"minItems":1},"prompts":{"type":"array","items":{"type":"string","minLength":1,"maxLength":500},"maxItems":50},"competitors":{"type":"array","items":{"type":"string","minLength":1,"maxLength":253},"maxItems":50}}}}}},"security":[{"accessKey":[]}],"responses":{"200":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","required":["success","data"],"properties":{"success":{"type":"boolean","enum":[true]},"data":{"type":"object","required":["id","name","domain","aliases","category","location","engines","prompts","competitors","createdAt","updatedAt"],"properties":{"id":{"type":"string"},"name":{"type":"string"},"domain":{"type":["null","string"]},"aliases":{"type":"array","items":{"type":"string"}},"category":{"type":["null","string"]},"location":{"type":"string"},"engines":{"type":"array","items":{"type":"string"}},"prompts":{"type":"array","items":{"type":"string"}},"competitors":{"type":"array","items":{"type":"string"}},"createdAt":{"type":"string"},"updatedAt":{"type":"string"}}}}}}}},"400":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","additionalProperties":false,"required":["success","message"],"properties":{"success":{"type":"boolean","enum":[false]},"message":{"type":"string"}}}}}},"401":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","additionalProperties":false,"required":["success","message"],"properties":{"success":{"type":"boolean","enum":[false]},"message":{"type":"string"}}}}}},"403":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","additionalProperties":false,"required":["success","message"],"properties":{"success":{"type":"boolean","enum":[false]},"message":{"type":"string"}}}}}}}},"get":{"operationId":"listBrands","summary":"List tracked brands","tags":["Brands"],"description":"Returns all brands for the organization. Free, no credits.","security":[{"accessKey":[]}],"responses":{"200":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","required":["success","data"],"properties":{"success":{"type":"boolean","enum":[true]},"data":{"type":"object","required":["brands"],"properties":{"brands":{"type":"array","items":{"type":"object","required":["id","name","domain","aliases","category","location","engines","prompts","competitors","createdAt","updatedAt"],"properties":{"id":{"type":"string"},"name":{"type":"string"},"domain":{"type":["null","string"]},"aliases":{"type":"array","items":{"type":"string"}},"category":{"type":["null","string"]},"location":{"type":"string"},"engines":{"type":"array","items":{"type":"string"}},"prompts":{"type":"array","items":{"type":"string"}},"competitors":{"type":"array","items":{"type":"string"}},"createdAt":{"type":"string"},"updatedAt":{"type":"string"}}}}}}}}}}},"401":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","additionalProperties":false,"required":["success","message"],"properties":{"success":{"type":"boolean","enum":[false]},"message":{"type":"string"}}}}}},"403":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","additionalProperties":false,"required":["success","message"],"properties":{"success":{"type":"boolean","enum":[false]},"message":{"type":"string"}}}}}}}}},"/v1/brands/{id}":{"get":{"operationId":"getBrand","summary":"Get a brand","tags":["Brands"],"parameters":[{"schema":{"type":"string"},"in":"path","name":"id","required":true}],"security":[{"accessKey":[]}],"responses":{"200":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","required":["success","data"],"properties":{"success":{"type":"boolean","enum":[true]},"data":{"type":"object","required":["id","name","domain","aliases","category","location","engines","prompts","competitors","createdAt","updatedAt"],"properties":{"id":{"type":"string"},"name":{"type":"string"},"domain":{"type":["null","string"]},"aliases":{"type":"array","items":{"type":"string"}},"category":{"type":["null","string"]},"location":{"type":"string"},"engines":{"type":"array","items":{"type":"string"}},"prompts":{"type":"array","items":{"type":"string"}},"competitors":{"type":"array","items":{"type":"string"}},"createdAt":{"type":"string"},"updatedAt":{"type":"string"}}}}}}}},"401":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","additionalProperties":false,"required":["success","message"],"properties":{"success":{"type":"boolean","enum":[false]},"message":{"type":"string"}}}}}},"403":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","additionalProperties":false,"required":["success","message"],"properties":{"success":{"type":"boolean","enum":[false]},"message":{"type":"string"}}}}}},"404":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","additionalProperties":false,"required":["success","message"],"properties":{"success":{"type":"boolean","enum":[false]},"message":{"type":"string"}}}}}}}},"patch":{"operationId":"updateBrand","summary":"Update a brand","tags":["Brands"],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","additionalProperties":false,"minProperties":1,"properties":{"name":{"type":"string","minLength":1,"maxLength":200},"domain":{"type":"string","maxLength":253},"aliases":{"type":"array","items":{"type":"string","minLength":1},"maxItems":25},"category":{"type":"string","maxLength":100},"location":{"type":"string","minLength":1},"engines":{"type":"array","items":{"type":"string","enum":["chatgpt","claude","gemini","perplexity"]},"uniqueItems":true,"minItems":1},"prompts":{"type":"array","items":{"type":"string","minLength":1,"maxLength":500},"maxItems":50},"competitors":{"type":"array","items":{"type":"string","minLength":1,"maxLength":253},"maxItems":50}}}}}},"parameters":[{"schema":{"type":"string"},"in":"path","name":"id","required":true}],"security":[{"accessKey":[]}],"responses":{"200":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","required":["success","data"],"properties":{"success":{"type":"boolean","enum":[true]},"data":{"type":"object","required":["id","name","domain","aliases","category","location","engines","prompts","competitors","createdAt","updatedAt"],"properties":{"id":{"type":"string"},"name":{"type":"string"},"domain":{"type":["null","string"]},"aliases":{"type":"array","items":{"type":"string"}},"category":{"type":["null","string"]},"location":{"type":"string"},"engines":{"type":"array","items":{"type":"string"}},"prompts":{"type":"array","items":{"type":"string"}},"competitors":{"type":"array","items":{"type":"string"}},"createdAt":{"type":"string"},"updatedAt":{"type":"string"}}}}}}}},"400":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","additionalProperties":false,"required":["success","message"],"properties":{"success":{"type":"boolean","enum":[false]},"message":{"type":"string"}}}}}},"401":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","additionalProperties":false,"required":["success","message"],"properties":{"success":{"type":"boolean","enum":[false]},"message":{"type":"string"}}}}}},"403":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","additionalProperties":false,"required":["success","message"],"properties":{"success":{"type":"boolean","enum":[false]},"message":{"type":"string"}}}}}},"404":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","additionalProperties":false,"required":["success","message"],"properties":{"success":{"type":"boolean","enum":[false]},"message":{"type":"string"}}}}}}}},"delete":{"operationId":"deleteBrand","summary":"Delete a brand","tags":["Brands"],"parameters":[{"schema":{"type":"string"},"in":"path","name":"id","required":true}],"security":[{"accessKey":[]}],"responses":{"200":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","required":["success","data"],"properties":{"success":{"type":"boolean","enum":[true]},"data":{"type":"object","required":["id","deleted"],"properties":{"id":{"type":"string"},"deleted":{"type":"boolean"}}}}}}}},"401":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","additionalProperties":false,"required":["success","message"],"properties":{"success":{"type":"boolean","enum":[false]},"message":{"type":"string"}}}}}},"403":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","additionalProperties":false,"required":["success","message"],"properties":{"success":{"type":"boolean","enum":[false]},"message":{"type":"string"}}}}}},"404":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","additionalProperties":false,"required":["success","message"],"properties":{"success":{"type":"boolean","enum":[false]},"message":{"type":"string"}}}}}}}}},"/v1/brands/{id}/prompts":{"get":{"operationId":"getBrandPrompts","summary":"List a brand's tracked prompts","tags":["Brands"],"parameters":[{"schema":{"type":"string"},"in":"path","name":"id","required":true}],"security":[{"accessKey":[]}],"responses":{"200":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","required":["success","data"],"properties":{"success":{"type":"boolean","enum":[true]},"data":{"type":"object","required":["id","prompts"],"properties":{"id":{"type":"string"},"prompts":{"type":"array","items":{"type":"string"}}}}}}}}},"401":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","additionalProperties":false,"required":["success","message"],"properties":{"success":{"type":"boolean","enum":[false]},"message":{"type":"string"}}}}}},"403":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","additionalProperties":false,"required":["success","message"],"properties":{"success":{"type":"boolean","enum":[false]},"message":{"type":"string"}}}}}},"404":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","additionalProperties":false,"required":["success","message"],"properties":{"success":{"type":"boolean","enum":[false]},"message":{"type":"string"}}}}}}}},"put":{"operationId":"setBrandPrompts","summary":"Replace a brand's tracked prompts","tags":["Brands"],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","additionalProperties":false,"required":["prompts"],"properties":{"prompts":{"type":"array","items":{"type":"string","minLength":1,"maxLength":500},"maxItems":50}}}}}},"parameters":[{"schema":{"type":"string"},"in":"path","name":"id","required":true}],"security":[{"accessKey":[]}],"responses":{"200":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","required":["success","data"],"properties":{"success":{"type":"boolean","enum":[true]},"data":{"type":"object","required":["id","prompts"],"properties":{"id":{"type":"string"},"prompts":{"type":"array","items":{"type":"string"}}}}}}}}},"400":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","additionalProperties":false,"required":["success","message"],"properties":{"success":{"type":"boolean","enum":[false]},"message":{"type":"string"}}}}}},"401":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","additionalProperties":false,"required":["success","message"],"properties":{"success":{"type":"boolean","enum":[false]},"message":{"type":"string"}}}}}},"403":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","additionalProperties":false,"required":["success","message"],"properties":{"success":{"type":"boolean","enum":[false]},"message":{"type":"string"}}}}}},"404":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","additionalProperties":false,"required":["success","message"],"properties":{"success":{"type":"boolean","enum":[false]},"message":{"type":"string"}}}}}}}}},"/v1/brands/{id}/competitors":{"get":{"operationId":"getBrandCompetitors","summary":"List a brand's competitors","tags":["Brands"],"parameters":[{"schema":{"type":"string"},"in":"path","name":"id","required":true}],"security":[{"accessKey":[]}],"responses":{"200":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","required":["success","data"],"properties":{"success":{"type":"boolean","enum":[true]},"data":{"type":"object","required":["id","competitors"],"properties":{"id":{"type":"string"},"competitors":{"type":"array","items":{"type":"string"}}}}}}}}},"401":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","additionalProperties":false,"required":["success","message"],"properties":{"success":{"type":"boolean","enum":[false]},"message":{"type":"string"}}}}}},"403":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","additionalProperties":false,"required":["success","message"],"properties":{"success":{"type":"boolean","enum":[false]},"message":{"type":"string"}}}}}},"404":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","additionalProperties":false,"required":["success","message"],"properties":{"success":{"type":"boolean","enum":[false]},"message":{"type":"string"}}}}}}}},"put":{"operationId":"setBrandCompetitors","summary":"Replace a brand's competitors","tags":["Brands"],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","additionalProperties":false,"required":["competitors"],"properties":{"competitors":{"type":"array","items":{"type":"string","minLength":1,"maxLength":253},"maxItems":50}}}}}},"parameters":[{"schema":{"type":"string"},"in":"path","name":"id","required":true}],"security":[{"accessKey":[]}],"responses":{"200":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","required":["success","data"],"properties":{"success":{"type":"boolean","enum":[true]},"data":{"type":"object","required":["id","competitors"],"properties":{"id":{"type":"string"},"competitors":{"type":"array","items":{"type":"string"}}}}}}}}},"400":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","additionalProperties":false,"required":["success","message"],"properties":{"success":{"type":"boolean","enum":[false]},"message":{"type":"string"}}}}}},"401":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","additionalProperties":false,"required":["success","message"],"properties":{"success":{"type":"boolean","enum":[false]},"message":{"type":"string"}}}}}},"403":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","additionalProperties":false,"required":["success","message"],"properties":{"success":{"type":"boolean","enum":[false]},"message":{"type":"string"}}}}}},"404":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","additionalProperties":false,"required":["success","message"],"properties":{"success":{"type":"boolean","enum":[false]},"message":{"type":"string"}}}}}}}}},"/v1/brands/{id}/timeline":{"get":{"operationId":"getBrandTimeline","summary":"Visibility timeline for a brand","tags":["Brands"],"description":"Aggregates a brand's stored snapshots into a daily timeline per engine: checks run, times mentioned, mention rate, average position, share of voice, and sentiment breakdown. Free.","parameters":[{"schema":{"type":"string","enum":["chatgpt","claude","gemini","perplexity"]},"in":"query","name":"engine","required":false},{"schema":{"type":"string"},"in":"query","name":"from","required":false},{"schema":{"type":"string"},"in":"query","name":"to","required":false},{"schema":{"type":"string"},"in":"path","name":"id","required":true}],"security":[{"accessKey":[]}],"responses":{"200":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","required":["success","data"],"properties":{"success":{"type":"boolean","enum":[true]},"data":{"type":"object","required":["brandId","points"],"properties":{"brandId":{"type":"string"},"points":{"type":"array","items":{"type":"object","required":["date","engine","checks","mentioned","mention_rate","avg_position"],"properties":{"date":{"type":"string"},"engine":{"type":"string"},"checks":{"type":"integer"},"mentioned":{"type":"integer"},"mention_rate":{"type":"number"},"avg_position":{"type":["null","number"]},"share_of_voice":{"type":["null","number"]},"sentiment":{"type":"object","properties":{"positive":{"type":"integer"},"neutral":{"type":"integer"},"negative":{"type":"integer"}}}}}}}}}}}}},"401":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","additionalProperties":false,"required":["success","message"],"properties":{"success":{"type":"boolean","enum":[false]},"message":{"type":"string"}}}}}},"403":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","additionalProperties":false,"required":["success","message"],"properties":{"success":{"type":"boolean","enum":[false]},"message":{"type":"string"}}}}}},"404":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","additionalProperties":false,"required":["success","message"],"properties":{"success":{"type":"boolean","enum":[false]},"message":{"type":"string"}}}}}}}}},"/v1/brands/{id}/overview":{"get":{"operationId":"getBrandOverview","summary":"Visibility overview rollup for a brand","tags":["Brands"],"description":"A single rollup of a brand's stored snapshots for a dashboard overview: coverage, average position, share of voice, sentiment split, a per-engine breakdown, and the most-mentioned competitors. Free.","parameters":[{"schema":{"type":"string","enum":["chatgpt","claude","gemini","perplexity"]},"in":"query","name":"engine","required":false},{"schema":{"type":"string"},"in":"query","name":"from","required":false},{"schema":{"type":"string"},"in":"query","name":"to","required":false},{"schema":{"type":"string"},"in":"path","name":"id","required":true}],"security":[{"accessKey":[]}],"responses":{"200":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","required":["success","data"],"properties":{"success":{"type":"boolean","enum":[true]},"data":{"type":"object","required":["brandId","checks","mentioned","coverage_pct","avg_position","share_of_voice","sentiment","by_engine","top_competitors"],"properties":{"brandId":{"type":"string"},"checks":{"type":"integer"},"mentioned":{"type":"integer"},"coverage_pct":{"type":"integer"},"avg_position":{"type":["null","number"]},"share_of_voice":{"type":["null","integer"]},"sentiment":{"type":"object","properties":{"positive":{"type":"integer"},"neutral":{"type":"integer"},"negative":{"type":"integer"},"overall":{"type":["null","string"]}}},"by_engine":{"type":"array","items":{"type":"object","properties":{"engine":{"type":"string"},"checks":{"type":"integer"},"mentioned":{"type":"integer"},"mention_rate":{"type":"number"},"avg_position":{"type":["null","number"]}}}},"top_competitors":{"type":"array","items":{"type":"object","properties":{"name":{"type":"string"},"count":{"type":"integer"}}}},"first_checked_at":{"type":["null","string"]},"last_checked_at":{"type":["null","string"]}}}}}}}},"401":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","additionalProperties":false,"required":["success","message"],"properties":{"success":{"type":"boolean","enum":[false]},"message":{"type":"string"}}}}}},"403":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","additionalProperties":false,"required":["success","message"],"properties":{"success":{"type":"boolean","enum":[false]},"message":{"type":"string"}}}}}},"404":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","additionalProperties":false,"required":["success","message"],"properties":{"success":{"type":"boolean","enum":[false]},"message":{"type":"string"}}}}}}}}},"/v1/rank/":{"post":{"operationId":"getRank","summary":"Google rank and AI Overview presence for a keyword","tags":["Rank"],"description":"Returns where a domain ranks in Google organic results for a keyword, and whether it appears in the Google AI Overview.","requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","additionalProperties":false,"required":["keyword","domain"],"properties":{"keyword":{"type":"string","minLength":1},"domain":{"type":"string","minLength":1},"location":{"type":"string","default":"United States"},"device":{"type":"string","enum":["desktop","mobile"],"default":"desktop"}}}}}},"security":[{"accessKey":[]}],"responses":{"200":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","required":["success","credits","data"],"properties":{"success":{"type":"boolean","enum":[true]},"credits":{"type":"object","required":["charged","remaining"],"properties":{"charged":{"type":"integer"},"remaining":{"type":"integer"}}},"data":{"type":"object","required":["keyword","domain","position","url","ai_overview"],"properties":{"keyword":{"type":"string"},"domain":{"type":"string"},"position":{"type":["null","integer"]},"url":{"type":["null","string"]},"ai_overview":{"type":"object","required":["present","cited"],"properties":{"present":{"type":"boolean"},"cited":{"type":"boolean"}}}}}}}}}},"400":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","additionalProperties":false,"required":["success","message"],"properties":{"success":{"type":"boolean","enum":[false]},"message":{"type":"string"}}}}}},"401":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","additionalProperties":false,"required":["success","message"],"properties":{"success":{"type":"boolean","enum":[false]},"message":{"type":"string"}}}}}},"402":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","additionalProperties":false,"required":["success","message"],"properties":{"success":{"type":"boolean","enum":[false]},"message":{"type":"string"}}}}}},"403":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","additionalProperties":false,"required":["success","message"],"properties":{"success":{"type":"boolean","enum":[false]},"message":{"type":"string"}}}}}}}}},"/v1/keywords/":{"post":{"operationId":"getKeywords","summary":"Search volume and metrics for a list of keywords","tags":["Keywords"],"description":"Returns monthly search volume, CPC, and competition for each keyword. Costs 1 credit per keyword, with a minimum of 20 credits per call.","requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","additionalProperties":false,"required":["keywords"],"properties":{"keywords":{"type":"array","minItems":1,"maxItems":100,"items":{"type":"string","minLength":1}},"location":{"type":"string","default":"United States"},"language":{"type":"string","default":"English"}}}}}},"security":[{"accessKey":[]}],"responses":{"200":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","required":["success","credits","data"],"properties":{"success":{"type":"boolean","enum":[true]},"credits":{"type":"object","required":["charged","remaining"],"properties":{"charged":{"type":"integer"},"remaining":{"type":"integer"}}},"data":{"type":"object","required":["location","language","keywords"],"properties":{"location":{"type":"string"},"language":{"type":"string"},"keywords":{"type":"array","items":{"type":"object","required":["keyword","volume","cpc","competition","competition_index"],"properties":{"keyword":{"type":"string"},"volume":{"type":["null","integer"]},"cpc":{"type":["null","number"]},"competition":{"type":["null","string"]},"competition_index":{"type":["null","integer"]}}}}}}}}}}},"400":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","additionalProperties":false,"required":["success","message"],"properties":{"success":{"type":"boolean","enum":[false]},"message":{"type":"string"}}}}}},"401":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","additionalProperties":false,"required":["success","message"],"properties":{"success":{"type":"boolean","enum":[false]},"message":{"type":"string"}}}}}},"402":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","additionalProperties":false,"required":["success","message"],"properties":{"success":{"type":"boolean","enum":[false]},"message":{"type":"string"}}}}}},"403":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","additionalProperties":false,"required":["success","message"],"properties":{"success":{"type":"boolean","enum":[false]},"message":{"type":"string"}}}}}}}}},"/v1/keyword-ideas/":{"post":{"operationId":"getKeywordIdeas","summary":"Related keyword ideas for a seed keyword","tags":["Keywords"],"description":"Returns keyword ideas related to a seed keyword, each with search volume, CPC, competition, and search intent. Costs 3 credits.","requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","additionalProperties":false,"required":["keyword"],"properties":{"keyword":{"type":"string","minLength":1,"maxLength":200},"location":{"type":"string","default":"United States"},"language":{"type":"string","default":"English"},"limit":{"type":"integer","minimum":1,"maximum":100,"default":20}}}}}},"security":[{"accessKey":[]}],"responses":{"200":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","required":["success","credits","data"],"properties":{"success":{"type":"boolean","enum":[true]},"credits":{"type":"object","required":["charged","remaining"],"properties":{"charged":{"type":"integer"},"remaining":{"type":"integer"}}},"data":{"type":"object","required":["seed","location","language","total","ideas"],"properties":{"seed":{"type":"string"},"location":{"type":"string"},"language":{"type":"string"},"total":{"type":["null","integer"]},"ideas":{"type":"array","items":{"type":"object","required":["keyword","volume","cpc","competition","competition_index","search_intent"],"properties":{"keyword":{"type":"string"},"volume":{"type":["null","integer"]},"cpc":{"type":["null","number"]},"competition":{"type":["null","string"]},"competition_index":{"type":["null","integer"]},"search_intent":{"type":["null","string"]}}}}}}}}}}},"400":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","additionalProperties":false,"required":["success","message"],"properties":{"success":{"type":"boolean","enum":[false]},"message":{"type":"string"}}}}}},"401":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","additionalProperties":false,"required":["success","message"],"properties":{"success":{"type":"boolean","enum":[false]},"message":{"type":"string"}}}}}},"402":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","additionalProperties":false,"required":["success","message"],"properties":{"success":{"type":"boolean","enum":[false]},"message":{"type":"string"}}}}}},"403":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","additionalProperties":false,"required":["success","message"],"properties":{"success":{"type":"boolean","enum":[false]},"message":{"type":"string"}}}}}}}}},"/v1/ai-keyword-volume/":{"post":{"operationId":"getAiKeywordVolume","summary":"AI search volume for a list of keywords","tags":["Keywords"],"description":"Returns how often each keyword is searched inside AI assistants, with a monthly trend. Costs 2 credits per keyword.","requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","additionalProperties":false,"required":["keywords"],"properties":{"keywords":{"type":"array","minItems":1,"maxItems":100,"items":{"type":"string","minLength":1}},"location":{"type":"string","default":"United States"},"language":{"type":"string","default":"English"}}}}}},"security":[{"accessKey":[]}],"responses":{"200":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","required":["success","credits","data"],"properties":{"success":{"type":"boolean","enum":[true]},"credits":{"type":"object","required":["charged","remaining"],"properties":{"charged":{"type":"integer"},"remaining":{"type":"integer"}}},"data":{"type":"object","required":["location","language","keywords"],"properties":{"location":{"type":"string"},"language":{"type":"string"},"keywords":{"type":"array","items":{"type":"object","required":["keyword","ai_search_volume","trend"],"properties":{"keyword":{"type":"string"},"ai_search_volume":{"type":["null","integer"]},"trend":{"type":"array","items":{"type":"object","required":["year","month","ai_search_volume"],"properties":{"year":{"type":"integer"},"month":{"type":"integer"},"ai_search_volume":{"type":["null","integer"]}}}}}}}}}}}}}},"400":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","additionalProperties":false,"required":["success","message"],"properties":{"success":{"type":"boolean","enum":[false]},"message":{"type":"string"}}}}}},"401":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","additionalProperties":false,"required":["success","message"],"properties":{"success":{"type":"boolean","enum":[false]},"message":{"type":"string"}}}}}},"402":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","additionalProperties":false,"required":["success","message"],"properties":{"success":{"type":"boolean","enum":[false]},"message":{"type":"string"}}}}}},"403":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","additionalProperties":false,"required":["success","message"],"properties":{"success":{"type":"boolean","enum":[false]},"message":{"type":"string"}}}}}}}}},"/v1/visibility/":{"post":{"operationId":"getVisibility","summary":"Check whether AI models mention a brand for a prompt","tags":["Visibility"],"description":"Runs a prompt across the selected AI engines (ChatGPT, Claude, Gemini, Perplexity) and reports whether the brand is mentioned, its position, competitors named alongside it, and a coverage / share-of-voice / sentiment rollup. Costs 3 credits per engine (+1 per engine when sentiment is enabled).","requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","additionalProperties":false,"required":["brand","prompt"],"properties":{"brand":{"type":"string","minLength":1},"prompt":{"type":"string","minLength":1},"engines":{"type":"array","minItems":1,"uniqueItems":true,"items":{"type":"string","enum":["chatgpt","claude","gemini","perplexity"]},"default":["chatgpt"]},"web_search":{"type":"boolean","default":false},"competitors":{"type":"array","maxItems":10,"uniqueItems":true,"items":{"type":"string","minLength":1},"description":"Competitor names to detect alongside your brand. Enables `competitors_found` per engine and the `share_of_voice` rollup."},"sentiment":{"type":"boolean","default":false,"description":"Classify how each engine that mentions the brand portrays it (positive/neutral/negative). Adds 1 credit per engine."},"brandId":{"type":"string","description":"Optional saved brand id. When set, the result is stored as a snapshot for history and timeline queries."}}}}}},"security":[{"accessKey":[]}],"responses":{"200":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","required":["success","credits","data"],"properties":{"success":{"type":"boolean","enum":[true]},"credits":{"type":"object","required":["charged","remaining"],"properties":{"charged":{"type":"integer"},"remaining":{"type":"integer"}}},"data":{"type":"object","required":["brand","prompt","mentioned_in","summary","results"],"properties":{"brand":{"type":"string"},"prompt":{"type":"string"},"saved":{"type":"integer"},"mentioned_in":{"type":"array","items":{"type":"string"}},"summary":{"type":"object","required":["coverage_pct","avg_position","share_of_voice"],"properties":{"coverage_pct":{"type":"integer"},"avg_position":{"type":["null","number"]},"share_of_voice":{"type":["null","integer"]},"sentiment":{"type":["null","object"],"properties":{"positive":{"type":"integer"},"neutral":{"type":"integer"},"negative":{"type":"integer"},"overall":{"type":"string"}}}}},"results":{"type":"array","items":{"type":"object","required":["engine","model","mentioned","position","competitors_found","sources"],"properties":{"engine":{"type":"string"},"model":{"type":"string"},"mentioned":{"type":"boolean"},"position":{"type":["null","integer"]},"competitors_found":{"type":"array","items":{"type":"string"}},"sentiment":{"type":["null","string"]},"sources":{"type":"array","items":{"type":"string"}},"answer":{"type":"string"}}}}}}}}}}},"400":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","additionalProperties":false,"required":["success","message"],"properties":{"success":{"type":"boolean","enum":[false]},"message":{"type":"string"}}}}}},"401":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","additionalProperties":false,"required":["success","message"],"properties":{"success":{"type":"boolean","enum":[false]},"message":{"type":"string"}}}}}},"402":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","additionalProperties":false,"required":["success","message"],"properties":{"success":{"type":"boolean","enum":[false]},"message":{"type":"string"}}}}}},"403":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","additionalProperties":false,"required":["success","message"],"properties":{"success":{"type":"boolean","enum":[false]},"message":{"type":"string"}}}}}}}}},"/v1/prompts/run":{"post":{"operationId":"runPrompt","summary":"Run a prompt across AI models and get their answers","tags":["Prompts"],"description":"Sends one prompt to the selected AI engines (ChatGPT, Claude, Gemini, Perplexity) and returns each model's full answer plus the sources it cited. Costs 3 credits per engine.","requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","additionalProperties":false,"required":["prompt"],"properties":{"prompt":{"type":"string","minLength":1,"maxLength":2000},"engines":{"type":"array","minItems":1,"uniqueItems":true,"items":{"type":"string","enum":["chatgpt","claude","gemini","perplexity"]},"default":["chatgpt"]},"web_search":{"type":"boolean","default":false}}}}}},"security":[{"accessKey":[]}],"responses":{"200":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","required":["success","credits","data"],"properties":{"success":{"type":"boolean","enum":[true]},"credits":{"type":"object","required":["charged","remaining"],"properties":{"charged":{"type":"integer"},"remaining":{"type":"integer"}}},"data":{"type":"object","required":["prompt","results"],"properties":{"prompt":{"type":"string"},"results":{"type":"array","items":{"type":"object","required":["engine","model","answer","sources"],"properties":{"engine":{"type":"string"},"model":{"type":"string"},"answer":{"type":"string"},"sources":{"type":"array","items":{"type":"string"}}}}}}}}}}}},"400":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","additionalProperties":false,"required":["success","message"],"properties":{"success":{"type":"boolean","enum":[false]},"message":{"type":"string"}}}}}},"401":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","additionalProperties":false,"required":["success","message"],"properties":{"success":{"type":"boolean","enum":[false]},"message":{"type":"string"}}}}}},"402":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","additionalProperties":false,"required":["success","message"],"properties":{"success":{"type":"boolean","enum":[false]},"message":{"type":"string"}}}}}},"403":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","additionalProperties":false,"required":["success","message"],"properties":{"success":{"type":"boolean","enum":[false]},"message":{"type":"string"}}}}}}}}},"/v1/snapshots/":{"get":{"operationId":"querySnapshots","summary":"Query stored visibility snapshots","tags":["Snapshots"],"description":"Returns stored visibility snapshots for the organization, filterable by brand, engine, prompt, mention, and date range. Free. Snapshots are created when a visibility check is run with a brandId.","parameters":[{"schema":{"type":"string"},"in":"query","name":"brand_id","required":false},{"schema":{"type":"string","enum":["chatgpt","claude","gemini","perplexity"]},"in":"query","name":"engine","required":false},{"schema":{"type":"string"},"in":"query","name":"prompt","required":false},{"schema":{"type":"boolean"},"in":"query","name":"mentioned","required":false},{"schema":{"type":"string"},"in":"query","name":"from","required":false},{"schema":{"type":"string"},"in":"query","name":"to","required":false},{"schema":{"type":"integer","minimum":1,"maximum":200,"default":50},"in":"query","name":"limit","required":false},{"schema":{"type":"integer","minimum":0,"default":0},"in":"query","name":"offset","required":false}],"security":[{"accessKey":[]}],"responses":{"200":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","required":["success","data"],"properties":{"success":{"type":"boolean","enum":[true]},"data":{"type":"object","required":["total","limit","offset","snapshots"],"properties":{"total":{"type":"integer"},"limit":{"type":"integer"},"offset":{"type":"integer"},"snapshots":{"type":"array","items":{"type":"object","required":["id","brandId","brand","prompt","engine","model","mentioned","position","sources_count","checkedAt"],"properties":{"id":{"type":"string"},"brandId":{"type":"string"},"brand":{"type":"string"},"prompt":{"type":"string"},"engine":{"type":"string"},"model":{"type":["null","string"]},"mentioned":{"type":"boolean"},"position":{"type":["null","integer"]},"sources_count":{"type":"integer"},"sentiment":{"type":["null","string"]},"competitors_found":{"type":"array","items":{"type":"string"}},"checkedAt":{"type":"string"}}}}}}}}}}},"401":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","additionalProperties":false,"required":["success","message"],"properties":{"success":{"type":"boolean","enum":[false]},"message":{"type":"string"}}}}}},"403":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","additionalProperties":false,"required":["success","message"],"properties":{"success":{"type":"boolean","enum":[false]},"message":{"type":"string"}}}}}}}}},"/v1/trackers/":{"post":{"operationId":"createTracker","summary":"Schedule a recurring visibility scan for a brand","tags":["Trackers"],"description":"Creates a tracker that re-runs a saved brand's prompts across its AI engines on a schedule, saving a snapshot each time for history and alerts. Managing trackers is free; each scheduled run spends 3 credits per engine per prompt.","requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","additionalProperties":false,"required":["brandId","intervalMinutes"],"properties":{"brandId":{"type":"string","minLength":1},"name":{"type":"string","minLength":1,"maxLength":200},"intervalMinutes":{"type":"integer","minimum":60},"enabled":{"type":"boolean","default":true},"prompts":{"type":"array","items":{"type":"string","minLength":1},"description":"Override the brand's prompts for this tracker (empty = use the brand's)."},"engines":{"type":"array","uniqueItems":true,"items":{"type":"string","enum":["chatgpt","claude","gemini","perplexity"]},"description":"Override the brand's engines for this tracker (empty = use the brand's)."},"captureSentiment":{"type":"boolean","default":false,"description":"Classify sentiment on each run. Adds 1 credit per engine per prompt."}}}}}},"security":[{"accessKey":[]}],"responses":{"200":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","required":["success","data"],"properties":{"success":{"type":"boolean","enum":[true]},"data":{"type":"object","required":["id","organizationId","brandId","name","intervalMinutes","enabled","lastRunAt","nextRunAt","lastStatus","lastError","runCount","createdAt","updatedAt"],"properties":{"id":{"type":"string"},"organizationId":{"type":"string"},"brandId":{"type":"string"},"name":{"type":["null","string"]},"intervalMinutes":{"type":"integer"},"enabled":{"type":"boolean"},"prompts":{"type":"array","items":{"type":"string"}},"engines":{"type":"array","items":{"type":"string"}},"captureSentiment":{"type":"boolean"},"lastRunAt":{"type":["null","string"]},"nextRunAt":{"type":["null","string"]},"lastStatus":{"type":["null","string"]},"lastError":{"type":["null","string"]},"runCount":{"type":"integer"},"createdAt":{"type":"string"},"updatedAt":{"type":"string"}}}}}}}},"400":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","additionalProperties":false,"required":["success","message"],"properties":{"success":{"type":"boolean","enum":[false]},"message":{"type":"string"}}}}}},"401":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","additionalProperties":false,"required":["success","message"],"properties":{"success":{"type":"boolean","enum":[false]},"message":{"type":"string"}}}}}},"403":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","additionalProperties":false,"required":["success","message"],"properties":{"success":{"type":"boolean","enum":[false]},"message":{"type":"string"}}}}}},"404":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","additionalProperties":false,"required":["success","message"],"properties":{"success":{"type":"boolean","enum":[false]},"message":{"type":"string"}}}}}}}},"get":{"operationId":"listTrackers","summary":"List scheduled trackers","tags":["Trackers"],"description":"Returns all trackers for the organization. Free.","security":[{"accessKey":[]}],"responses":{"200":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","required":["success","data"],"properties":{"success":{"type":"boolean","enum":[true]},"data":{"type":"object","required":["trackers"],"properties":{"trackers":{"type":"array","items":{"type":"object","required":["id","organizationId","brandId","name","intervalMinutes","enabled","lastRunAt","nextRunAt","lastStatus","lastError","runCount","createdAt","updatedAt"],"properties":{"id":{"type":"string"},"organizationId":{"type":"string"},"brandId":{"type":"string"},"name":{"type":["null","string"]},"intervalMinutes":{"type":"integer"},"enabled":{"type":"boolean"},"prompts":{"type":"array","items":{"type":"string"}},"engines":{"type":"array","items":{"type":"string"}},"captureSentiment":{"type":"boolean"},"lastRunAt":{"type":["null","string"]},"nextRunAt":{"type":["null","string"]},"lastStatus":{"type":["null","string"]},"lastError":{"type":["null","string"]},"runCount":{"type":"integer"},"createdAt":{"type":"string"},"updatedAt":{"type":"string"}}}}}}}}}}},"401":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","additionalProperties":false,"required":["success","message"],"properties":{"success":{"type":"boolean","enum":[false]},"message":{"type":"string"}}}}}},"403":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","additionalProperties":false,"required":["success","message"],"properties":{"success":{"type":"boolean","enum":[false]},"message":{"type":"string"}}}}}}}}},"/v1/trackers/{id}":{"get":{"operationId":"getTracker","summary":"Get a tracker","tags":["Trackers"],"parameters":[{"schema":{"type":"string"},"in":"path","name":"id","required":true}],"security":[{"accessKey":[]}],"responses":{"200":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","required":["success","data"],"properties":{"success":{"type":"boolean","enum":[true]},"data":{"type":"object","required":["id","organizationId","brandId","name","intervalMinutes","enabled","lastRunAt","nextRunAt","lastStatus","lastError","runCount","createdAt","updatedAt"],"properties":{"id":{"type":"string"},"organizationId":{"type":"string"},"brandId":{"type":"string"},"name":{"type":["null","string"]},"intervalMinutes":{"type":"integer"},"enabled":{"type":"boolean"},"prompts":{"type":"array","items":{"type":"string"}},"engines":{"type":"array","items":{"type":"string"}},"captureSentiment":{"type":"boolean"},"lastRunAt":{"type":["null","string"]},"nextRunAt":{"type":["null","string"]},"lastStatus":{"type":["null","string"]},"lastError":{"type":["null","string"]},"runCount":{"type":"integer"},"createdAt":{"type":"string"},"updatedAt":{"type":"string"}}}}}}}},"401":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","additionalProperties":false,"required":["success","message"],"properties":{"success":{"type":"boolean","enum":[false]},"message":{"type":"string"}}}}}},"403":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","additionalProperties":false,"required":["success","message"],"properties":{"success":{"type":"boolean","enum":[false]},"message":{"type":"string"}}}}}},"404":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","additionalProperties":false,"required":["success","message"],"properties":{"success":{"type":"boolean","enum":[false]},"message":{"type":"string"}}}}}}}},"patch":{"operationId":"updateTracker","summary":"Update a tracker (cadence, enable/disable, rename)","tags":["Trackers"],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","additionalProperties":false,"minProperties":1,"properties":{"name":{"type":"string","minLength":1,"maxLength":200},"intervalMinutes":{"type":"integer","minimum":60},"enabled":{"type":"boolean"},"prompts":{"type":"array","items":{"type":"string","minLength":1}},"engines":{"type":"array","uniqueItems":true,"items":{"type":"string","enum":["chatgpt","claude","gemini","perplexity"]}},"captureSentiment":{"type":"boolean"}}}}}},"parameters":[{"schema":{"type":"string"},"in":"path","name":"id","required":true}],"security":[{"accessKey":[]}],"responses":{"200":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","required":["success","data"],"properties":{"success":{"type":"boolean","enum":[true]},"data":{"type":"object","required":["id","organizationId","brandId","name","intervalMinutes","enabled","lastRunAt","nextRunAt","lastStatus","lastError","runCount","createdAt","updatedAt"],"properties":{"id":{"type":"string"},"organizationId":{"type":"string"},"brandId":{"type":"string"},"name":{"type":["null","string"]},"intervalMinutes":{"type":"integer"},"enabled":{"type":"boolean"},"prompts":{"type":"array","items":{"type":"string"}},"engines":{"type":"array","items":{"type":"string"}},"captureSentiment":{"type":"boolean"},"lastRunAt":{"type":["null","string"]},"nextRunAt":{"type":["null","string"]},"lastStatus":{"type":["null","string"]},"lastError":{"type":["null","string"]},"runCount":{"type":"integer"},"createdAt":{"type":"string"},"updatedAt":{"type":"string"}}}}}}}},"400":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","additionalProperties":false,"required":["success","message"],"properties":{"success":{"type":"boolean","enum":[false]},"message":{"type":"string"}}}}}},"401":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","additionalProperties":false,"required":["success","message"],"properties":{"success":{"type":"boolean","enum":[false]},"message":{"type":"string"}}}}}},"403":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","additionalProperties":false,"required":["success","message"],"properties":{"success":{"type":"boolean","enum":[false]},"message":{"type":"string"}}}}}},"404":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","additionalProperties":false,"required":["success","message"],"properties":{"success":{"type":"boolean","enum":[false]},"message":{"type":"string"}}}}}}}},"delete":{"operationId":"deleteTracker","summary":"Delete a tracker","tags":["Trackers"],"parameters":[{"schema":{"type":"string"},"in":"path","name":"id","required":true}],"security":[{"accessKey":[]}],"responses":{"200":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","required":["success","data"],"properties":{"success":{"type":"boolean","enum":[true]},"data":{"type":"object","required":["id","deleted"],"properties":{"id":{"type":"string"},"deleted":{"type":"boolean"}}}}}}}},"401":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","additionalProperties":false,"required":["success","message"],"properties":{"success":{"type":"boolean","enum":[false]},"message":{"type":"string"}}}}}},"403":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","additionalProperties":false,"required":["success","message"],"properties":{"success":{"type":"boolean","enum":[false]},"message":{"type":"string"}}}}}},"404":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","additionalProperties":false,"required":["success","message"],"properties":{"success":{"type":"boolean","enum":[false]},"message":{"type":"string"}}}}}}}}},"/v1/trackers/{id}/run":{"post":{"operationId":"runTracker","summary":"Run a tracker now","tags":["Trackers"],"description":"Enqueues an immediate scan for the tracker (in addition to its schedule). The scan spends credits when it runs. Returns queued=false if the job queue is not configured.","parameters":[{"schema":{"type":"string"},"in":"path","name":"id","required":true}],"security":[{"accessKey":[]}],"responses":{"200":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","required":["success","data"],"properties":{"success":{"type":"boolean","enum":[true]},"data":{"type":"object","required":["id","queued"],"properties":{"id":{"type":"string"},"queued":{"type":"boolean"}}}}}}}},"401":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","additionalProperties":false,"required":["success","message"],"properties":{"success":{"type":"boolean","enum":[false]},"message":{"type":"string"}}}}}},"403":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","additionalProperties":false,"required":["success","message"],"properties":{"success":{"type":"boolean","enum":[false]},"message":{"type":"string"}}}}}},"404":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","additionalProperties":false,"required":["success","message"],"properties":{"success":{"type":"boolean","enum":[false]},"message":{"type":"string"}}}}}}}}},"/v1/scans/":{"post":{"operationId":"createScan","summary":"Start a bulk AI visibility scan","tags":["Scans"],"description":"Runs a grid of prompts × engines as a background job. Returns a scan id immediately (status 'pending'); poll GET /v1/scans/:id until 'completed'. Costs 5 credits per check (prompts × engines), +1 per check with sentiment. Charged upfront.","requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","additionalProperties":false,"required":["brand","prompts"],"properties":{"brand":{"type":"string","minLength":1},"domain":{"type":"string"},"prompts":{"type":"array","minItems":1,"maxItems":25,"items":{"type":"string","minLength":1}},"engines":{"type":"array","minItems":1,"uniqueItems":true,"items":{"type":"string","enum":["chatgpt","claude","gemini"]},"default":["chatgpt"],"description":"Async-capable engines only (chatgpt, claude, gemini). Perplexity has no async mode — use /v1/visibility for it."},"competitors":{"type":"array","maxItems":10,"uniqueItems":true,"items":{"type":"string","minLength":1}},"sentiment":{"type":"boolean","default":false},"web_search":{"type":"boolean","default":false},"brandId":{"type":"string","description":"Optional saved brand id. Completed checks are stored as snapshots for history and timeline."}}}}}},"security":[{"accessKey":[]}],"responses":{"200":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","required":["success","credits","data"],"properties":{"success":{"type":"boolean","enum":[true]},"credits":{"type":"object","required":["charged","remaining"],"properties":{"charged":{"type":"integer"},"remaining":{"type":"integer"}}},"data":{"type":"object","required":["id","brand","status","progress","done","results"],"properties":{"id":{"type":"string"},"brandId":{"type":["null","string"]},"brand":{"type":"string"},"domain":{"type":["null","string"]},"status":{"type":"string"},"progress":{"type":"object","properties":{"total":{"type":"integer"},"completed":{"type":"integer"},"failed":{"type":"integer"},"pending":{"type":"integer"}}},"done":{"type":"boolean"},"prompts":{"type":"array","items":{"type":"string"}},"engines":{"type":"array","items":{"type":"string"}},"results":{"type":"array","items":{"type":"object","required":["prompt","engine","status"],"properties":{"prompt":{"type":"string"},"engine":{"type":"string"},"status":{"type":"string"},"mentioned":{"type":["null","boolean"]},"position":{"type":["null","integer"]},"competitors_found":{"type":"array","items":{"type":"string"}},"sentiment":{"type":["null","string"]},"sources_count":{"type":"integer"},"error":{"type":["null","string"]}}}},"createdAt":{"type":"string"},"completedAt":{"type":["null","string"]}}}}}}}},"400":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","additionalProperties":false,"required":["success","message"],"properties":{"success":{"type":"boolean","enum":[false]},"message":{"type":"string"}}}}}},"401":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","additionalProperties":false,"required":["success","message"],"properties":{"success":{"type":"boolean","enum":[false]},"message":{"type":"string"}}}}}},"402":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","additionalProperties":false,"required":["success","message"],"properties":{"success":{"type":"boolean","enum":[false]},"message":{"type":"string"}}}}}},"403":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","additionalProperties":false,"required":["success","message"],"properties":{"success":{"type":"boolean","enum":[false]},"message":{"type":"string"}}}}}}}},"get":{"operationId":"listScans","summary":"List recent scans","tags":["Scans"],"description":"Returns the organization's recent scans, newest first. Free.","parameters":[{"schema":{"type":"integer","minimum":1,"maximum":100,"default":20},"in":"query","name":"limit","required":false},{"schema":{"type":"integer","minimum":0,"default":0},"in":"query","name":"offset","required":false}],"security":[{"accessKey":[]}],"responses":{"200":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","required":["success","data"],"properties":{"success":{"type":"boolean","enum":[true]},"data":{"type":"object","required":["total","scans"],"properties":{"total":{"type":"integer"},"scans":{"type":"array","items":{"type":"object","required":["id","brand","status","progress","done","results"],"properties":{"id":{"type":"string"},"brandId":{"type":["null","string"]},"brand":{"type":"string"},"domain":{"type":["null","string"]},"status":{"type":"string"},"progress":{"type":"object","properties":{"total":{"type":"integer"},"completed":{"type":"integer"},"failed":{"type":"integer"},"pending":{"type":"integer"}}},"done":{"type":"boolean"},"prompts":{"type":"array","items":{"type":"string"}},"engines":{"type":"array","items":{"type":"string"}},"results":{"type":"array","items":{"type":"object","required":["prompt","engine","status"],"properties":{"prompt":{"type":"string"},"engine":{"type":"string"},"status":{"type":"string"},"mentioned":{"type":["null","boolean"]},"position":{"type":["null","integer"]},"competitors_found":{"type":"array","items":{"type":"string"}},"sentiment":{"type":["null","string"]},"sources_count":{"type":"integer"},"error":{"type":["null","string"]}}}},"createdAt":{"type":"string"},"completedAt":{"type":["null","string"]}}}}}}}}}}},"401":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","additionalProperties":false,"required":["success","message"],"properties":{"success":{"type":"boolean","enum":[false]},"message":{"type":"string"}}}}}},"403":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","additionalProperties":false,"required":["success","message"],"properties":{"success":{"type":"boolean","enum":[false]},"message":{"type":"string"}}}}}}}}},"/v1/scans/{id}":{"get":{"operationId":"getScan","summary":"Get a scan's status and results","tags":["Scans"],"description":"Returns a scan's status, progress, and per-check results. Polling this advances the scan — it fetches any newly-ready checks from DataForSEO. Poll until `done` is true. Free.","parameters":[{"schema":{"type":"string"},"in":"path","name":"id","required":true}],"security":[{"accessKey":[]}],"responses":{"200":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","required":["success","data"],"properties":{"success":{"type":"boolean","enum":[true]},"data":{"type":"object","required":["id","brand","status","progress","done","results"],"properties":{"id":{"type":"string"},"brandId":{"type":["null","string"]},"brand":{"type":"string"},"domain":{"type":["null","string"]},"status":{"type":"string"},"progress":{"type":"object","properties":{"total":{"type":"integer"},"completed":{"type":"integer"},"failed":{"type":"integer"},"pending":{"type":"integer"}}},"done":{"type":"boolean"},"prompts":{"type":"array","items":{"type":"string"}},"engines":{"type":"array","items":{"type":"string"}},"results":{"type":"array","items":{"type":"object","required":["prompt","engine","status"],"properties":{"prompt":{"type":"string"},"engine":{"type":"string"},"status":{"type":"string"},"mentioned":{"type":["null","boolean"]},"position":{"type":["null","integer"]},"competitors_found":{"type":"array","items":{"type":"string"}},"sentiment":{"type":["null","string"]},"sources_count":{"type":"integer"},"error":{"type":["null","string"]}}}},"createdAt":{"type":"string"},"completedAt":{"type":["null","string"]}}}}}}}},"401":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","additionalProperties":false,"required":["success","message"],"properties":{"success":{"type":"boolean","enum":[false]},"message":{"type":"string"}}}}}},"403":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","additionalProperties":false,"required":["success","message"],"properties":{"success":{"type":"boolean","enum":[false]},"message":{"type":"string"}}}}}},"404":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","additionalProperties":false,"required":["success","message"],"properties":{"success":{"type":"boolean","enum":[false]},"message":{"type":"string"}}}}}}}}},"/v1/alerts/":{"get":{"operationId":"getAlerts","summary":"Visibility change alerts from your trackers","tags":["Alerts"],"description":"Returns the change events your trackers detected between scheduled runs — when your brand is dropped from or added to a prompt, its position moves, a competitor newly appears, or sentiment shifts. Poll this to react to visibility changes. Free.","parameters":[{"schema":{"type":"string"},"in":"query","name":"brand_id","required":false},{"schema":{"type":"string","enum":["mention_lost","mention_gained","position_changed","competitor_new","sentiment_changed"]},"in":"query","name":"type","required":false},{"schema":{"type":"string"},"in":"query","name":"from","required":false},{"schema":{"type":"string"},"in":"query","name":"to","required":false},{"schema":{"type":"integer","minimum":1,"maximum":200,"default":50},"in":"query","name":"limit","required":false},{"schema":{"type":"integer","minimum":0,"default":0},"in":"query","name":"offset","required":false}],"security":[{"accessKey":[]}],"responses":{"200":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","required":["success","data"],"properties":{"success":{"type":"boolean","enum":[true]},"data":{"type":"object","required":["total","limit","offset","alerts"],"properties":{"total":{"type":"integer"},"limit":{"type":"integer"},"offset":{"type":"integer"},"alerts":{"type":"array","items":{"type":"object","required":["id","brandId","brand","trackerId","prompt","engine","type","message","createdAt"],"properties":{"id":{"type":"string"},"brandId":{"type":"string"},"brand":{"type":"string"},"trackerId":{"type":"string"},"prompt":{"type":"string"},"engine":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"createdAt":{"type":"string"}}}}}}}}}}},"400":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","additionalProperties":false,"required":["success","message"],"properties":{"success":{"type":"boolean","enum":[false]},"message":{"type":"string"}}}}}},"401":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","additionalProperties":false,"required":["success","message"],"properties":{"success":{"type":"boolean","enum":[false]},"message":{"type":"string"}}}}}},"403":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","additionalProperties":false,"required":["success","message"],"properties":{"success":{"type":"boolean","enum":[false]},"message":{"type":"string"}}}}}}}}},"/v1/recommendations/":{"post":{"operationId":"getRecommendations","summary":"Actionable recommendations to improve AI visibility","tags":["Recommendations"],"description":"Analyzes a saved brand's stored visibility snapshots and returns prioritized, actionable recommendations — the prompts you're missing where competitors appear, negative-sentiment topics, weak engines, and your biggest competitive threat. Free (reads data you already collected). Run visibility checks or a tracker first to build up snapshots.","requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","additionalProperties":false,"required":["brandId"],"properties":{"brandId":{"type":"string","minLength":1},"from":{"type":"string"},"to":{"type":"string"}}}}}},"security":[{"accessKey":[]}],"responses":{"200":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","required":["success","data"],"properties":{"success":{"type":"boolean","enum":[true]},"data":{"type":"object","required":["brandId","brand","count","recommendations"],"properties":{"brandId":{"type":"string"},"brand":{"type":"string"},"count":{"type":"integer"},"recommendations":{"type":"array","items":{"type":"object","required":["category","priority","title","detail"],"properties":{"category":{"type":"string"},"priority":{"type":"string"},"title":{"type":"string"},"detail":{"type":"string"},"evidence":{"type":"object","additionalProperties":true}}}}}}}}}}},"400":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","additionalProperties":false,"required":["success","message"],"properties":{"success":{"type":"boolean","enum":[false]},"message":{"type":"string"}}}}}},"401":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","additionalProperties":false,"required":["success","message"],"properties":{"success":{"type":"boolean","enum":[false]},"message":{"type":"string"}}}}}},"403":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","additionalProperties":false,"required":["success","message"],"properties":{"success":{"type":"boolean","enum":[false]},"message":{"type":"string"}}}}}},"404":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","additionalProperties":false,"required":["success","message"],"properties":{"success":{"type":"boolean","enum":[false]},"message":{"type":"string"}}}}}}}}},"/v1/backlinks/":{"post":{"operationId":"getBacklinks","summary":"Backlink profile summary for a domain","tags":["Backlinks"],"description":"Returns a domain's backlink profile: total backlinks, referring domains, domain rank (authority), spam score, broken links, and a breakdown by link type and country. Costs 8 credits.","requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","additionalProperties":false,"required":["target"],"properties":{"target":{"type":"string","minLength":1,"description":"Domain, subdomain, or URL to analyze (e.g. 'stripe.com')."},"include_subdomains":{"type":"boolean","default":true}}}}}},"security":[{"accessKey":[]}],"responses":{"200":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","required":["success","credits","data"],"properties":{"success":{"type":"boolean","enum":[true]},"credits":{"type":"object","required":["charged","remaining"],"properties":{"charged":{"type":"integer"},"remaining":{"type":"integer"}}},"data":{"type":"object","required":["target","backlinks","referring_domains","rank"],"properties":{"target":{"type":"string"},"backlinks":{"type":"integer"},"referring_domains":{"type":"integer"},"referring_main_domains":{"type":["null","integer"]},"referring_pages":{"type":["null","integer"]},"broken_backlinks":{"type":["null","integer"]},"broken_pages":{"type":["null","integer"]},"rank":{"type":["null","integer"]},"spam_score":{"type":["null","integer"]},"link_types":{"type":"object","additionalProperties":true},"top_countries":{"type":"object","additionalProperties":true}}}}}}}},"400":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","additionalProperties":false,"required":["success","message"],"properties":{"success":{"type":"boolean","enum":[false]},"message":{"type":"string"}}}}}},"401":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","additionalProperties":false,"required":["success","message"],"properties":{"success":{"type":"boolean","enum":[false]},"message":{"type":"string"}}}}}},"402":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","additionalProperties":false,"required":["success","message"],"properties":{"success":{"type":"boolean","enum":[false]},"message":{"type":"string"}}}}}},"403":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","additionalProperties":false,"required":["success","message"],"properties":{"success":{"type":"boolean","enum":[false]},"message":{"type":"string"}}}}}}}}},"/v1/domain-overview/":{"post":{"operationId":"getDomainOverview","summary":"Organic search overview for a domain","tags":["Domain Overview"],"description":"Returns a domain's organic search footprint: how many keywords it ranks for, estimated monthly organic traffic, position distribution (top 3/10/20/100), and how its rankings are moving. Costs 5 credits.","requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","additionalProperties":false,"required":["domain"],"properties":{"domain":{"type":"string","minLength":1},"location":{"type":"string","default":"United States"},"language":{"type":"string","default":"English"}}}}}},"security":[{"accessKey":[]}],"responses":{"200":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","required":["success","credits","data"],"properties":{"success":{"type":"boolean","enum":[true]},"credits":{"type":"object","required":["charged","remaining"],"properties":{"charged":{"type":"integer"},"remaining":{"type":"integer"}}},"data":{"type":"object","required":["domain","organic_keywords","organic_traffic"],"properties":{"domain":{"type":"string"},"location":{"type":"string"},"organic_keywords":{"type":"integer"},"organic_traffic":{"type":"number"},"estimated_traffic_cost":{"type":["null","number"]},"positions":{"type":"object","properties":{"top_3":{"type":"integer"},"top_10":{"type":"integer"},"top_20":{"type":"integer"},"top_100":{"type":"integer"}}},"movement":{"type":"object","properties":{"up":{"type":"integer"},"down":{"type":"integer"},"new":{"type":"integer"},"lost":{"type":"integer"}}}}}}}}}},"400":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","additionalProperties":false,"required":["success","message"],"properties":{"success":{"type":"boolean","enum":[false]},"message":{"type":"string"}}}}}},"401":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","additionalProperties":false,"required":["success","message"],"properties":{"success":{"type":"boolean","enum":[false]},"message":{"type":"string"}}}}}},"402":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","additionalProperties":false,"required":["success","message"],"properties":{"success":{"type":"boolean","enum":[false]},"message":{"type":"string"}}}}}},"403":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","additionalProperties":false,"required":["success","message"],"properties":{"success":{"type":"boolean","enum":[false]},"message":{"type":"string"}}}}}}}}},"/v1/ranked-keywords/":{"post":{"operationId":"getRankedKeywords","summary":"Keywords a domain ranks for in Google","tags":["Ranked Keywords"],"description":"Returns the keywords a domain currently ranks for in Google organic search, each with its position, search volume, CPC, difficulty, estimated traffic value, and the ranking URL. Costs 10 credits.","requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","additionalProperties":false,"required":["domain"],"properties":{"domain":{"type":"string","minLength":1},"location":{"type":"string","default":"United States"},"language":{"type":"string","default":"English"},"limit":{"type":"integer","minimum":1,"maximum":100,"default":50}}}}}},"security":[{"accessKey":[]}],"responses":{"200":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","required":["success","credits","data"],"properties":{"success":{"type":"boolean","enum":[true]},"credits":{"type":"object","required":["charged","remaining"],"properties":{"charged":{"type":"integer"},"remaining":{"type":"integer"}}},"data":{"type":"object","required":["domain","total","keywords"],"properties":{"domain":{"type":"string"},"location":{"type":"string"},"total":{"type":["null","integer"]},"keywords":{"type":"array","items":{"type":"object","required":["keyword","position","search_volume"],"properties":{"keyword":{"type":"string"},"position":{"type":["null","integer"]},"search_volume":{"type":["null","integer"]},"cpc":{"type":["null","number"]},"difficulty":{"type":["null","integer"]},"etv":{"type":["null","number"]},"url":{"type":["null","string"]}}}}}}}}}}},"400":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","additionalProperties":false,"required":["success","message"],"properties":{"success":{"type":"boolean","enum":[false]},"message":{"type":"string"}}}}}},"401":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","additionalProperties":false,"required":["success","message"],"properties":{"success":{"type":"boolean","enum":[false]},"message":{"type":"string"}}}}}},"402":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","additionalProperties":false,"required":["success","message"],"properties":{"success":{"type":"boolean","enum":[false]},"message":{"type":"string"}}}}}},"403":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","additionalProperties":false,"required":["success","message"],"properties":{"success":{"type":"boolean","enum":[false]},"message":{"type":"string"}}}}}}}}},"/v1/audit/":{"post":{"operationId":"getAudit","summary":"On-page SEO audit for a URL","tags":["Audit"],"description":"Runs an instant on-page SEO audit of a single URL and returns its on-page score, the specific issues found (missing title, no H1, broken links, render-blocking resources, and more), meta summary, and load timing. Costs 2 credits.","requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","additionalProperties":false,"required":["url"],"properties":{"url":{"type":"string","minLength":1,"description":"The full page URL to audit (e.g. 'https://example.com/pricing')."}}}}}},"security":[{"accessKey":[]}],"responses":{"200":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","required":["success","credits","data"],"properties":{"success":{"type":"boolean","enum":[true]},"credits":{"type":"object","required":["charged","remaining"],"properties":{"charged":{"type":"integer"},"remaining":{"type":"integer"}}},"data":{"type":"object","required":["url","onpage_score","issues"],"properties":{"url":{"type":"string"},"status_code":{"type":["null","integer"]},"onpage_score":{"type":"number"},"issues":{"type":"array","items":{"type":"string"}},"meta":{"type":"object","additionalProperties":true},"page_timing":{"type":"object","additionalProperties":true}}}}}}}},"400":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","additionalProperties":false,"required":["success","message"],"properties":{"success":{"type":"boolean","enum":[false]},"message":{"type":"string"}}}}}},"401":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","additionalProperties":false,"required":["success","message"],"properties":{"success":{"type":"boolean","enum":[false]},"message":{"type":"string"}}}}}},"402":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","additionalProperties":false,"required":["success","message"],"properties":{"success":{"type":"boolean","enum":[false]},"message":{"type":"string"}}}}}},"403":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","additionalProperties":false,"required":["success","message"],"properties":{"success":{"type":"boolean","enum":[false]},"message":{"type":"string"}}}}}}}}},"/v1/mentions/":{"post":{"operationId":"getMentions","summary":"Real AI answers that mention a brand","tags":["Mentions"],"description":"Finds the actual AI answers (Google AI Overviews or ChatGPT) where a brand is mentioned, including the user question that triggered them, the answer text, cited sources, and other brands named. Costs 35 credits.","requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","additionalProperties":false,"required":["brand"],"properties":{"brand":{"type":"string","minLength":1},"domain":{"type":"string","description":"The brand's domain (e.g. 'polar.sh'). Strongly recommended — scopes results to answers that actually cite your site, which disambiguates common-word brand names. Without it, matching falls back to the brand name in the answer text."},"platform":{"type":"string","enum":["google","chat_gpt"],"default":"google","description":"Which AI surface to search. `google` = Google AI Overviews (all locales). `chat_gpt` = ChatGPT (US + English only)."},"location":{"type":"string","default":"United States"},"language":{"type":"string","default":"English"},"scope":{"type":"array","minItems":1,"uniqueItems":true,"items":{"type":"string","enum":["any","question","answer","brand_entities","fan_out_queries"]},"default":["answer"],"description":"Where in the AI response to look for the brand."},"limit":{"type":"integer","minimum":1,"maximum":100,"default":20}}}}}},"security":[{"accessKey":[]}],"responses":{"200":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","required":["success","credits","data"],"properties":{"success":{"type":"boolean","enum":[true]},"credits":{"type":"object","required":["charged","remaining"],"properties":{"charged":{"type":"integer"},"remaining":{"type":"integer"}}},"data":{"type":"object","required":["brand","platform","total_mentions","mentions"],"properties":{"brand":{"type":"string"},"platform":{"type":"string"},"total_mentions":{"type":"integer"},"mentions":{"type":"array","items":{"type":"object","required":["platform","question","answer","sources"],"properties":{"platform":{"type":"string"},"model":{"type":["null","string"]},"question":{"type":["null","string"]},"answer":{"type":["null","string"]},"ai_search_volume":{"type":["null","integer"]},"first_response_at":{"type":["null","string"]},"last_response_at":{"type":["null","string"]},"sources":{"type":"array","items":{"type":"object","properties":{"url":{"type":["null","string"]},"domain":{"type":["null","string"]},"title":{"type":["null","string"]},"snippet":{"type":["null","string"]},"source_name":{"type":["null","string"]},"position":{"type":["null","integer"]}}}},"brand_entities":{"type":"array","items":{"type":"object","properties":{"position":{"type":["null","integer"]},"title":{"type":["null","string"]},"category":{"type":["null","string"]}}}}}}}}}}}}}},"400":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","additionalProperties":false,"required":["success","message"],"properties":{"success":{"type":"boolean","enum":[false]},"message":{"type":"string"}}}}}},"401":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","additionalProperties":false,"required":["success","message"],"properties":{"success":{"type":"boolean","enum":[false]},"message":{"type":"string"}}}}}},"402":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","additionalProperties":false,"required":["success","message"],"properties":{"success":{"type":"boolean","enum":[false]},"message":{"type":"string"}}}}}},"403":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","additionalProperties":false,"required":["success","message"],"properties":{"success":{"type":"boolean","enum":[false]},"message":{"type":"string"}}}}}}}}},"/v1/mentions/history":{"post":{"operationId":"getMentionsHistory","summary":"Month-by-month AI mention history for a brand","tags":["Mentions"],"description":"Returns roughly the last 13 months of how often a brand is mentioned in AI answers, with the AI search volume behind those mentions. Use it to chart whether your AI visibility is trending up or down. Costs 35 credits.","requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","additionalProperties":false,"required":["brand"],"properties":{"brand":{"type":"string","minLength":1},"domain":{"type":"string","description":"The brand's domain (e.g. 'polar.sh'). Strongly recommended — scopes results to answers that actually cite your site, which disambiguates common-word brand names. Without it, matching falls back to the brand name in the answer text."},"platform":{"type":"string","enum":["google","chat_gpt"],"default":"google"},"location":{"type":"string","default":"United States"},"language":{"type":"string","default":"English"},"scope":{"type":"array","minItems":1,"uniqueItems":true,"items":{"type":"string","enum":["any","question","answer","brand_entities","fan_out_queries"]},"default":["answer"]}}}}}},"security":[{"accessKey":[]}],"responses":{"200":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","required":["success","credits","data"],"properties":{"success":{"type":"boolean","enum":[true]},"credits":{"type":"object","required":["charged","remaining"],"properties":{"charged":{"type":"integer"},"remaining":{"type":"integer"}}},"data":{"type":"object","required":["brand","platform","history"],"properties":{"brand":{"type":"string"},"platform":{"type":"string"},"history":{"type":"array","items":{"type":"object","required":["year","month","mentions","ai_search_volume"],"properties":{"year":{"type":"integer"},"month":{"type":"integer"},"mentions":{"type":"integer"},"ai_search_volume":{"type":"integer"}}}}}}}}}}},"400":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","additionalProperties":false,"required":["success","message"],"properties":{"success":{"type":"boolean","enum":[false]},"message":{"type":"string"}}}}}},"401":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","additionalProperties":false,"required":["success","message"],"properties":{"success":{"type":"boolean","enum":[false]},"message":{"type":"string"}}}}}},"402":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","additionalProperties":false,"required":["success","message"],"properties":{"success":{"type":"boolean","enum":[false]},"message":{"type":"string"}}}}}},"403":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","additionalProperties":false,"required":["success","message"],"properties":{"success":{"type":"boolean","enum":[false]},"message":{"type":"string"}}}}}}}}},"/v1/citations/":{"post":{"operationId":"getCitations","summary":"Pages and domains AI models cite about a brand","tags":["Citations"],"description":"Returns the pages (or domains) most frequently cited as sources by AI answers that mention a brand, with each source's mention count and share of voice. Reveals which content is shaping what AI says about you. Costs 35 credits.","requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","additionalProperties":false,"required":["brand"],"properties":{"brand":{"type":"string","minLength":1},"domain":{"type":"string","description":"The brand's domain (e.g. 'polar.sh'). Strongly recommended — scopes to answers that cite your site, disambiguating common-word brand names."},"group_by":{"type":"string","enum":["pages","domains"],"default":"pages","description":"Return the most-cited individual `pages` or aggregate them by `domains`."},"platform":{"type":"string","enum":["google","chat_gpt"],"default":"google","description":"`google` = Google AI Overviews (all locales). `chat_gpt` = ChatGPT (US + English only)."},"location":{"type":"string","default":"United States"},"language":{"type":"string","default":"English"},"scope":{"type":"array","minItems":1,"uniqueItems":true,"items":{"type":"string","enum":["any","question","answer","brand_entities","fan_out_queries"]},"default":["answer"]},"limit":{"type":"integer","minimum":1,"maximum":10,"default":10}}}}}},"security":[{"accessKey":[]}],"responses":{"200":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","required":["success","credits","data"],"properties":{"success":{"type":"boolean","enum":[true]},"credits":{"type":"object","required":["charged","remaining"],"properties":{"charged":{"type":"integer"},"remaining":{"type":"integer"}}},"data":{"type":"object","required":["brand","group_by","total_mentions","citations"],"properties":{"brand":{"type":"string"},"group_by":{"type":"string"},"total_mentions":{"type":"integer"},"citations":{"type":"array","items":{"type":"object","required":["key","mentions","share"],"properties":{"key":{"type":"string"},"mentions":{"type":"integer"},"ai_search_volume":{"type":"integer"},"share":{"type":"number"}}}}}}}}}}},"400":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","additionalProperties":false,"required":["success","message"],"properties":{"success":{"type":"boolean","enum":[false]},"message":{"type":"string"}}}}}},"401":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","additionalProperties":false,"required":["success","message"],"properties":{"success":{"type":"boolean","enum":[false]},"message":{"type":"string"}}}}}},"402":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","additionalProperties":false,"required":["success","message"],"properties":{"success":{"type":"boolean","enum":[false]},"message":{"type":"string"}}}}}},"403":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","additionalProperties":false,"required":["success","message"],"properties":{"success":{"type":"boolean","enum":[false]},"message":{"type":"string"}}}}}}}}},"/v1/competitors/":{"post":{"operationId":"getCompetitors","summary":"SERP competitors for a set of keywords","tags":["Competitors"],"description":"Returns the domains competing for the given keywords in Google search, ranked by visibility, with average position and estimated traffic value. Costs 5 credits.","requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","additionalProperties":false,"required":["keywords"],"properties":{"keywords":{"type":"array","minItems":1,"maxItems":20,"items":{"type":"string","minLength":1}},"location":{"type":"string","default":"United States"},"language":{"type":"string","default":"English"},"limit":{"type":"integer","minimum":1,"maximum":50,"default":10}}}}}},"security":[{"accessKey":[]}],"responses":{"200":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","required":["success","credits","data"],"properties":{"success":{"type":"boolean","enum":[true]},"credits":{"type":"object","required":["charged","remaining"],"properties":{"charged":{"type":"integer"},"remaining":{"type":"integer"}}},"data":{"type":"object","required":["keywords","location","total","competitors"],"properties":{"keywords":{"type":"array","items":{"type":"string"}},"location":{"type":"string"},"total":{"type":["null","integer"]},"competitors":{"type":"array","items":{"type":"object","required":["domain","avg_position","visibility","etv","keywords_count"],"properties":{"domain":{"type":"string"},"avg_position":{"type":["null","number"]},"visibility":{"type":["null","number"]},"etv":{"type":["null","number"]},"keywords_count":{"type":["null","integer"]}}}}}}}}}}},"400":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","additionalProperties":false,"required":["success","message"],"properties":{"success":{"type":"boolean","enum":[false]},"message":{"type":"string"}}}}}},"401":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","additionalProperties":false,"required":["success","message"],"properties":{"success":{"type":"boolean","enum":[false]},"message":{"type":"string"}}}}}},"402":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","additionalProperties":false,"required":["success","message"],"properties":{"success":{"type":"boolean","enum":[false]},"message":{"type":"string"}}}}}},"403":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","additionalProperties":false,"required":["success","message"],"properties":{"success":{"type":"boolean","enum":[false]},"message":{"type":"string"}}}}}}}}}},"servers":[{"url":"https://api.trackee.dev","description":"Production"}]}