{"openapi":"3.0.0","info":{"title":"Otterly Public API","version":"1.0.0"},"tags":[{"name":"Engines"},{"name":"Workspaces"},{"name":"Brand Reports"},{"name":"Audits"},{"name":"Accounts"}],"servers":[{"url":"https://data.otterly.ai"}],"components":{"securitySchemes":{"BearerAuth":{"type":"http","scheme":"bearer","description":"Provide your API key as a Bearer token: `Authorization: Bearer YOUR_API_KEY`."}},"schemas":{"EnginesResponse":{"type":"object","properties":{"items":{"type":"array","items":{"$ref":"#/components/schemas/EngineCountryEntry"}}},"required":["items"]},"EngineCountryEntry":{"type":"object","properties":{"country":{"type":"string"},"baseEngines":{"type":"array","items":{"type":"string"}},"addonEngines":{"type":"array","items":{"type":"string"}}},"required":["country","baseEngines","addonEngines"]},"PublicApiValidationErrorResponse":{"type":"object","properties":{"message":{"type":"string"},"target":{"type":"string"},"errors":{"type":"array","items":{"type":"object","properties":{"path":{"type":"string"},"message":{"type":"string"},"code":{"type":"string"}},"required":["path","message","code"]}}},"required":["message","target","errors"],"example":{"message":"Validation failed","target":"query","errors":[{"path":"country","message":"Required","code":"invalid_type"}]}},"PublicApiErrorResponse":{"type":"object","properties":{"message":{"type":"string"}},"required":["message"],"example":{"message":"Report not found"}},"PublicApiWorkspacesList":{"type":"object","properties":{"items":{"type":"array","items":{"$ref":"#/components/schemas/PublicApiWorkspace"}},"paging":{"$ref":"#/components/schemas/PublicApiCursorPageInfo"}},"required":["items","paging"],"example":{"items":[{"id":"01HX7K2YV9D3M8N0G6Q5R4S3T2","name":"Adidas Brand Tracking","promptsUsedCount":142,"promptsMaxCount":500,"geoAuditUsedCount":7,"geoAuditMaxCount":25,"createdDate":"2024-09-15T10:30:00.000Z","updatedDate":"2025-04-12T14:20:00.000Z"}],"paging":{"nextCursor":null,"hasMore":false}}},"PublicApiWorkspace":{"type":"object","properties":{"id":{"type":"string","minLength":1,"example":"01HX7K2YV9D3M8N0G6Q5R4S3T2"},"name":{"type":"string"},"promptsUsedCount":{"type":"number","description":"Prompts already consumed in the current billing period."},"promptsMaxCount":{"type":"number","description":"Maximum prompts allowed for this workspace."},"geoAuditUsedCount":{"type":"number","description":"GEO audits already consumed in the current billing period."},"geoAuditMaxCount":{"type":"number","description":"Maximum GEO audits allowed for this workspace."},"createdDate":{"type":"string"},"updatedDate":{"type":"string"}},"required":["id","name","promptsUsedCount","promptsMaxCount","geoAuditUsedCount","geoAuditMaxCount","createdDate","updatedDate"],"example":{"id":"01HX7K2YV9D3M8N0G6Q5R4S3T2","name":"Adidas Brand Tracking","promptsUsedCount":142,"promptsMaxCount":500,"geoAuditUsedCount":7,"geoAuditMaxCount":25,"createdDate":"2024-09-15T10:30:00.000Z","updatedDate":"2025-04-12T14:20:00.000Z"}},"PublicApiCursorPageInfo":{"type":"object","properties":{"nextCursor":{"type":"string","nullable":true},"hasMore":{"type":"boolean"}},"required":["nextCursor","hasMore"],"example":{"nextCursor":null,"hasMore":false}},"PublicApiWorkspaceTagsList":{"type":"object","properties":{"items":{"type":"array","items":{"$ref":"#/components/schemas/PublicApiWorkspaceTag"}},"paging":{"$ref":"#/components/schemas/PublicApiCursorPageInfo"}},"required":["items","paging"],"example":{"items":[{"id":"01HX8AB3CDE4FG5HJ6KL7MN8PQ","workspaceId":"01HX7K2YV9D3M8N0G6Q5R4S3T2","name":"Running Shoes","color":"orange","promptCount":23,"createdDate":"2024-10-01T09:00:00.000Z","updatedDate":"2025-04-10T11:45:00.000Z"}],"paging":{"nextCursor":null,"hasMore":false}}},"PublicApiWorkspaceTag":{"type":"object","properties":{"id":{"type":"string","minLength":1,"example":"01HX7K2YV9D3M8N0G6Q5R4S3T2"},"workspaceId":{"type":"string"},"name":{"type":"string"},"color":{"type":"string","description":"Tag color (Ant Design preset color name, e.g. 'gold', 'orange', 'magenta', 'green', 'blue')."},"promptCount":{"type":"integer","minimum":0,"description":"Number of prompts currently associated with this tag."},"createdDate":{"type":"string"},"updatedDate":{"type":"string"}},"required":["id","workspaceId","name","color","promptCount","createdDate","updatedDate"],"example":{"id":"01HX8AB3CDE4FG5HJ6KL7MN8PQ","workspaceId":"01HX7K2YV9D3M8N0G6Q5R4S3T2","name":"Running Shoes","color":"orange","promptCount":23,"createdDate":"2024-10-01T09:00:00.000Z","updatedDate":"2025-04-10T11:45:00.000Z"}},"PublicApiCrawlabilityChecksList":{"type":"object","properties":{"items":{"type":"array","items":{"$ref":"#/components/schemas/PublicApiCrawlabilityCheckListItem"}},"paging":{"$ref":"#/components/schemas/PublicApiCursorPageInfo"}},"required":["items","paging"],"example":{"items":[{"id":"01HXCRAW1MZB7VAW4PQ8K2N3J9","workspaceId":"01HX7K2YV9D3M8N0G6Q5R4S3T2","url":"https://www.adidas.com/us/running","domain":"adidas.com","createdDate":"2026-01-26T08:29:45.000Z"},{"id":"01KGMWMRTN1MVAD6496SJHG3MV","workspaceId":"01HX7K2YV9D3M8N0G6Q5R4S3T2","url":"https://nike.com","domain":"nike.com","createdDate":"2026-02-04T17:54:15.000Z"}],"paging":{"nextCursor":null,"hasMore":false}}},"PublicApiCrawlabilityCheckListItem":{"type":"object","properties":{"id":{"type":"string","minLength":1,"example":"01HX7K2YV9D3M8N0G6Q5R4S3T2"},"workspaceId":{"type":"string"},"url":{"type":"string"},"domain":{"type":"string"},"createdDate":{"type":"string"}},"required":["id","workspaceId","url","domain","createdDate"],"example":{"id":"01HXCRAW1MZB7VAW4PQ8K2N3J9","workspaceId":"01HX7K2YV9D3M8N0G6Q5R4S3T2","url":"https://www.adidas.com/us/running","domain":"adidas.com","createdDate":"2026-01-26T08:29:45.000Z"}},"PublicApiCrawlabilityCheck":{"type":"object","properties":{"id":{"type":"string","minLength":1,"example":"01HX7K2YV9D3M8N0G6Q5R4S3T2"},"workspaceId":{"type":"string"},"url":{"type":"string"},"domain":{"type":"string"},"status":{"type":"string","enum":["pending","completed","failed"]},"createdDate":{"type":"string"},"completedDate":{"type":"string"},"robotsTxtAnalysis":{"type":"object","additionalProperties":{"type":"boolean","nullable":true}},"robotsTxtAnalysisResult":{"type":"boolean"},"serverBotAccess":{"type":"object","additionalProperties":{"$ref":"#/components/schemas/PublicApiServerBotAccessResult"},"description":"Per-bot probe results. Keys are crawler names as they appear in robots.txt / User-Agent (e.g. `GPTBot`, `PerplexityBot`, `ClaudeBot`, `Google-Extended`, `OAI-SearchBot`, `ChatGPT-User`); values describe whether each bot was able to fetch the resource."}},"required":["id","workspaceId","url","domain","status","createdDate"],"example":{"id":"01HXCRAW1MZB7VAW4PQ8K2N3J9","workspaceId":"01HX7K2YV9D3M8N0G6Q5R4S3T2","url":"https://www.adidas.com/us/running","domain":"adidas.com","status":"completed","createdDate":"2026-01-26T08:29:44.850Z","completedDate":"2026-01-26T08:30:14.540Z","robotsTxtAnalysis":{"GPTBot":true,"PerplexityBot":true,"ClaudeBot":true,"Google-Extended":true,"OAI-SearchBot":true,"ChatGPT-User":true,"CCBot":true},"robotsTxtAnalysisResult":true,"serverBotAccess":{"GPTBot":{"userAgent":"Mozilla/5.0 (compatible; GPTBot/1.0; +https://openai.com/gptbot)","status":200,"ok":true},"PerplexityBot":{"userAgent":"Mozilla/5.0 (compatible; PerplexityBot/1.0; +https://www.perplexity.ai/bot)","status":200,"ok":true},"ClaudeBot":{"userAgent":"Mozilla/5.0 (compatible; ClaudeBot/1.0; +https://www.anthropic.com)","status":200,"ok":true},"Google-Extended":{"userAgent":"Mozilla/5.0 (compatible; Googlebot/2.1; +http://www.google.com/bot.html)","status":200,"ok":true}}}},"PublicApiServerBotAccessResult":{"type":"object","properties":{"userAgent":{"type":"string","description":"User-Agent string used for the probe."},"status":{"type":"number","nullable":true,"description":"HTTP response status code observed by the probe; null if no response."},"ok":{"type":"boolean","description":"True when the probe was able to read the resource without restrictions."},"error":{"type":"string"},"errorReason":{"type":"string"}},"required":["userAgent","status","ok"],"example":{"userAgent":"Mozilla/5.0 (compatible; GPTBot/1.0; +https://openai.com/gptbot)","status":200,"ok":true}},"PublicApiContentChecksList":{"type":"object","properties":{"items":{"type":"array","items":{"$ref":"#/components/schemas/PublicApiContentCheckListItem"}},"paging":{"$ref":"#/components/schemas/PublicApiCursorPageInfo"}},"required":["items","paging"],"example":{"items":[{"id":"01HXCONTENT5XY8Z2N3KQ7VAW4","workspaceId":"01HX7K2YV9D3M8N0G6Q5R4S3T2","url":"https://www.adidas.com/us/running","createdDate":"2026-01-26T08:52:13.000Z"}],"paging":{"nextCursor":null,"hasMore":false}}},"PublicApiContentCheckListItem":{"type":"object","properties":{"id":{"type":"string","minLength":1,"example":"01HX7K2YV9D3M8N0G6Q5R4S3T2"},"workspaceId":{"type":"string"},"url":{"type":"string"},"createdDate":{"type":"string"}},"required":["id","workspaceId","url","createdDate"],"example":{"id":"01HXCONTENT5XY8Z2N3KQ7VAW4","workspaceId":"01HX7K2YV9D3M8N0G6Q5R4S3T2","url":"https://www.adidas.com/us/running","createdDate":"2026-01-26T08:52:13.000Z"}},"PublicApiContentCheck":{"type":"object","properties":{"id":{"type":"string","minLength":1,"example":"01HX7K2YV9D3M8N0G6Q5R4S3T2"},"workspaceId":{"type":"string"},"url":{"type":"string"},"status":{"type":"string","enum":["pending","completed","failed"]},"createdDate":{"type":"string"},"aiReadinessStats":{"type":"object","additionalProperties":{"nullable":true}},"pageSpeedScore":{"type":"object","additionalProperties":{"nullable":true}},"structuralAnalysis":{"type":"object","additionalProperties":{"nullable":true}},"dynamicContent":{"type":"object","additionalProperties":{"nullable":true}},"serverBotAccess":{"type":"object","additionalProperties":{"$ref":"#/components/schemas/PublicApiServerBotAccessResult"},"description":"Per-bot probe results. Keys are crawler names as they appear in robots.txt / User-Agent (e.g. `GPTBot`, `PerplexityBot`, `ClaudeBot`, `Google-Extended`, `OAI-SearchBot`, `ChatGPT-User`); values describe whether each bot was able to fetch the resource."}},"required":["id","workspaceId","url","status","createdDate"],"example":{"id":"01HXCONTENT5XY8Z2N3KQ7VAW4","workspaceId":"01HX7K2YV9D3M8N0G6Q5R4S3T2","url":"https://www.adidas.com/us/running","status":"completed","createdDate":"2026-01-13T09:46:46.251Z","structuralAnalysis":{"overallScore":68.3,"categoryScores":{"metadata":92,"technical":100,"structure":64,"content":46},"metadata":{"score":92,"breakdown":{"titleTag":{"maxScore":30,"score":30},"openGraphTags":{"maxScore":15,"score":12},"metaDescription":{"maxScore":30,"score":25},"structuredData":{"maxScore":25,"score":25}}},"technical":{"score":100,"breakdown":{"mobileFriendlyIndicators":{"maxScore":30,"score":30},"validHtmlStructure":{"maxScore":40,"score":40},"robotsAndCrawling":{"maxScore":20,"score":20},"languageDeclaration":{"maxScore":10,"score":10}}},"structure":{"score":64,"breakdown":{"listsAndStructuredContent":{"maxScore":20,"score":0},"paragraphStructure":{"maxScore":15,"score":10},"headingHierarchy":{"maxScore":30,"score":30},"semanticElements":{"maxScore":25,"score":14},"navigationStructure":{"maxScore":10,"score":10}}},"content":{"score":46,"breakdown":{"richContentElements":{"maxScore":60,"score":36},"contentVariety":{"maxScore":40,"score":10}}}},"dynamicContent":{"differenceDescription":"Found 1/2 matching chunks. Missing 1 chunks from dynamic content.","score":50},"serverBotAccess":{"GPTBot":{"userAgent":"Mozilla/5.0 (compatible; GPTBot/1.0; +https://openai.com/gptbot)","status":200,"ok":true},"PerplexityBot":{"userAgent":"Mozilla/5.0 (compatible; PerplexityBot/1.0; +https://www.perplexity.ai/bot)","status":200,"ok":true},"ClaudeBot":{"userAgent":"Mozilla/5.0 (compatible; ClaudeBot/1.0; +https://www.anthropic.com)","status":200,"ok":true},"Google-Extended":{"userAgent":"Mozilla/5.0 (compatible; Googlebot/2.1; +http://www.google.com/bot.html)","status":200,"ok":true}}}},"PublicApiCreateCrawlabilityCheckResponse":{"type":"object","properties":{"id":{"type":"string","minLength":1,"example":"01HX7K2YV9D3M8N0G6Q5R4S3T2"},"workspaceId":{"type":"string","minLength":1,"example":"01HX7K2YV9D3M8N0G6Q5R4S3T2"},"url":{"type":"string"},"status":{"type":"string","enum":["pending"]},"createdDate":{"type":"string"}},"required":["id","workspaceId","url","status","createdDate"]},"PublicApiCreateCrawlabilityCheckRequest":{"type":"object","properties":{"workspaceId":{"type":"string","minLength":1,"example":"01HX7K2YV9D3M8N0G6Q5R4S3T2"},"url":{"type":"string","format":"uri"}},"required":["workspaceId","url"]},"PublicApiCreateContentCheckResponse":{"type":"object","properties":{"id":{"type":"string","minLength":1,"example":"01HX7K2YV9D3M8N0G6Q5R4S3T2"},"workspaceId":{"type":"string","minLength":1,"example":"01HX7K2YV9D3M8N0G6Q5R4S3T2"},"url":{"type":"string"},"status":{"type":"string","enum":["pending"]},"createdDate":{"type":"string"}},"required":["id","workspaceId","url","status","createdDate"]},"PublicApiCreateContentCheckRequest":{"type":"object","properties":{"workspaceId":{"type":"string","minLength":1,"example":"01HX7K2YV9D3M8N0G6Q5R4S3T2"},"url":{"type":"string","format":"uri"},"crawlerIdentity":{"type":"string","enum":["ChatGPT-User","OAI-SearchBot","PerplexityCrawler","GoogleBot"],"description":"Crawler identity to impersonate when fetching the URL.","example":"ChatGPT-User"},"sendOtterlyHeader":{"type":"boolean"}},"required":["workspaceId","url"]},"PublicApiBrandReportsList":{"type":"object","properties":{"items":{"type":"array","items":{"$ref":"#/components/schemas/PublicApiBrandReportListItem"}},"paging":{"$ref":"#/components/schemas/PublicApiCursorPageInfo"}},"required":["items","paging"],"example":{"items":[{"id":"01HXBR1DGM5XY8Z2N3KQ7VAW4P","workspaceId":"01HX7K2YV9D3M8N0G6Q5R4S3T2","brand":"Adidas","brandVariations":["adidas","Adidas AG"],"brandDomain":"adidas.com","brandDomainVariations":["adidas.de","adidas.co.uk"],"brandDomainWildcard":false,"countries":["us","de","uk"],"competitors":[{"brand":"Nike","brandVariations":["nike","Nike Inc."],"brandDomain":"nike.com","brandDomainVariations":["nike.de","nike.co.uk"],"brandDomainWildcard":false}],"reportTitle":"Adidas Visibility Report","createdDate":"2024-11-01T12:00:00.000Z","updatedDate":"2025-05-01T08:30:00.000Z"}],"paging":{"nextCursor":null,"hasMore":false}}},"PublicApiBrandReportListItem":{"type":"object","properties":{"id":{"type":"string","minLength":1,"example":"01HX7K2YV9D3M8N0G6Q5R4S3T2"},"workspaceId":{"type":"string"},"brand":{"type":"string"},"brandVariations":{"type":"array","items":{"type":"string"}},"brandDomain":{"type":"string"},"brandDomainVariations":{"type":"array","items":{"type":"string"}},"brandDomainWildcard":{"type":"boolean"},"countries":{"type":"array","items":{"type":"string"},"description":"Lowercase ISO 3166-1 alpha-2 country codes the report tracks (e.g. `us`, `de`), with `uk` used in place of `gb`."},"competitors":{"type":"array","items":{"$ref":"#/components/schemas/PublicApiBrandCompetitor"}},"reportTitle":{"type":"string"},"createdDate":{"type":"string"},"updatedDate":{"type":"string"}},"required":["id","workspaceId","brand","brandDomain","countries","createdDate","updatedDate"],"example":{"id":"01HXBR1DGM5XY8Z2N3KQ7VAW4P","workspaceId":"01HX7K2YV9D3M8N0G6Q5R4S3T2","brand":"Adidas","brandVariations":["adidas","Adidas AG"],"brandDomain":"adidas.com","brandDomainVariations":["adidas.de","adidas.co.uk"],"brandDomainWildcard":false,"countries":["us","de","uk"],"competitors":[{"brand":"Nike","brandVariations":["nike","Nike Inc."],"brandDomain":"nike.com","brandDomainVariations":["nike.de","nike.co.uk"],"brandDomainWildcard":false}],"reportTitle":"Adidas Visibility Report","createdDate":"2024-11-01T12:00:00.000Z","updatedDate":"2025-05-01T08:30:00.000Z"}},"PublicApiBrandCompetitor":{"type":"object","properties":{"brand":{"type":"string","description":"Competitor brand name."},"brandVariations":{"type":"array","items":{"type":"string"}},"brandDomain":{"type":"string"},"brandDomainVariations":{"type":"array","items":{"type":"string"}},"brandDomainWildcard":{"type":"boolean"}},"required":["brand","brandVariations","brandDomain","brandDomainVariations","brandDomainWildcard"],"example":{"brand":"Nike","brandVariations":["nike","Nike Inc."],"brandDomain":"nike.com","brandDomainVariations":["nike.de","nike.co.uk"],"brandDomainWildcard":false}},"PublicApiBrandReport":{"type":"object","properties":{"id":{"type":"string","minLength":1,"example":"01HX7K2YV9D3M8N0G6Q5R4S3T2"},"workspaceId":{"type":"string"},"brand":{"type":"string"},"reportTitle":{"type":"string"},"brandVariations":{"type":"array","items":{"type":"string"}},"brandDomain":{"type":"string"},"brandDomainVariations":{"type":"array","items":{"type":"string"}},"brandDomainWildcard":{"type":"boolean"},"countries":{"type":"array","items":{"type":"string"},"description":"Lowercase ISO 3166-1 alpha-2 country codes the report tracks (e.g. `us`, `de`), with `uk` used in place of `gb`."},"createdDate":{"type":"string"},"updatedDate":{"type":"string"},"promptIds":{"type":"array","items":{"type":"string"}},"countryPromptsTotal":{"type":"object","additionalProperties":{"type":"number"},"description":"Total prompt count keyed by country code (lowercase ISO 3166-1 alpha-2; `uk` instead of `gb`)."},"competitors":{"type":"array","items":{"$ref":"#/components/schemas/PublicApiBrandCompetitor"}},"tags":{"type":"array","items":{"$ref":"#/components/schemas/PublicApiBrandReportTag"}}},"required":["id","workspaceId","brand","brandDomain","countries","createdDate","updatedDate"],"example":{"id":"01HXBR1DGM5XY8Z2N3KQ7VAW4P","workspaceId":"01HX7K2YV9D3M8N0G6Q5R4S3T2","brand":"Adidas","brandVariations":["adidas","Adidas AG"],"brandDomain":"adidas.com","brandDomainVariations":["adidas.de","adidas.co.uk"],"brandDomainWildcard":false,"countries":["us","de","uk"],"competitors":[{"brand":"Nike","brandVariations":["nike","Nike Inc."],"brandDomain":"nike.com","brandDomainVariations":["nike.de","nike.co.uk"],"brandDomainWildcard":false}],"reportTitle":"Adidas Visibility Report","createdDate":"2024-11-01T12:00:00.000Z","updatedDate":"2025-05-01T08:30:00.000Z","promptIds":["01HXP1DRTM5G8Z2N3KQ7VAW4PA","01HXP2DRTM5G8Z2N3KQ7VAW4PB"],"countryPromptsTotal":{"us":50,"de":35,"uk":28},"tags":[{"id":"01HX8AB3CDE4FG5HJ6KL7MN8PQ","name":"Running Shoes","color":"orange"}]}},"PublicApiBrandReportTag":{"type":"object","properties":{"id":{"type":"string","minLength":1,"example":"01HX7K2YV9D3M8N0G6Q5R4S3T2"},"name":{"type":"string"},"color":{"type":"string","description":"Tag color (Ant Design preset color name, e.g. 'gold', 'orange', 'magenta', 'green', 'blue')."}},"required":["id","name","color"],"example":{"id":"01HX8AB3CDE4FG5HJ6KL7MN8PQ","name":"Running Shoes","color":"orange"}},"PublicApiBrandReportStats":{"type":"object","properties":{"id":{"type":"string"},"status":{"type":"string"},"isRecalculating":{"type":"boolean"},"totalPrompts":{"type":"integer","minimum":0},"brand":{"type":"object","properties":{"brand":{"type":"string"},"brandDomain":{"type":"string"},"brandDomainWildcard":{"type":"boolean"}},"required":["brand","brandDomain"]},"summary":{"type":"object","properties":{"averageRank":{"type":"number","nullable":true},"averagePosition":{"type":"number","nullable":true},"totalMentions":{"type":"integer","minimum":0},"totalSources":{"type":"integer","minimum":0},"shareOfVoice":{"type":"number"},"brandCoverage":{"type":"number"},"domainCoverage":{"type":"number"}},"required":["averageRank","averagePosition","totalMentions","totalSources","shareOfVoice","brandCoverage","domainCoverage"]},"detectedBrands":{"type":"array","items":{"type":"object","properties":{"name":{"type":"string"},"mentions":{"type":"number"}},"required":["name","mentions"]}},"allBrandsAnalysis":{"type":"object","properties":{"brandMentions":{"type":"array","items":{"type":"object","properties":{"brand":{"type":"string"},"isMainBrand":{"type":"boolean"},"rank":{"type":"number"},"mentions":{"type":"number"},"shareOfVoice":{"type":"number"},"brandCoverage":{"type":"number"}},"required":["brand","isMainBrand","rank","mentions","shareOfVoice","brandCoverage"]}},"brandRankHistory":{"type":"array","items":{"type":"object","properties":{"date":{"type":"string"},"brands":{"type":"array","items":{"type":"object","properties":{"brand":{"type":"string"},"isMainBrand":{"type":"boolean"},"rank":{"type":"number"}},"required":["brand","isMainBrand","rank"]}}},"required":["date","brands"]}},"brandCoverageHistory":{"type":"array","items":{"type":"object","properties":{"date":{"type":"string"},"brands":{"type":"array","items":{"type":"object","properties":{"brand":{"type":"string"},"isMainBrand":{"type":"boolean"},"logoUrl":{"type":"string"},"coverage":{"type":"number"}},"required":["brand","isMainBrand","logoUrl","coverage"]}}},"required":["date","brands"]}},"brandPositionHistory":{"type":"array","items":{"type":"object","properties":{"date":{"type":"string"},"brands":{"type":"array","items":{"type":"object","properties":{"brand":{"type":"string"},"isMainBrand":{"type":"boolean"},"position":{"type":"number"}},"required":["brand","isMainBrand","position"]}}},"required":["date","brands"]}},"brandVisibilityIndex":{"type":"array","items":{"type":"object","properties":{"date":{"type":"string"},"brands":{"type":"array","items":{"type":"object","properties":{"brand":{"type":"string"},"isMainBrand":{"type":"boolean"},"visibilityScore":{"type":"number"},"brandCoverage":{"type":"number"},"likelihoodToBuy":{"type":"number"}},"required":["brand","isMainBrand","visibilityScore","brandCoverage","likelihoodToBuy"]}}},"required":["date","brands"]}},"domainCoverageHistory":{"type":"array","items":{"type":"object","properties":{"date":{"type":"string"},"domains":{"type":"array","items":{"type":"object","properties":{"domain":{"type":"string"},"isMainBrand":{"type":"boolean"},"logoUrl":{"type":"string"},"coverage":{"type":"number"}},"required":["domain","isMainBrand","logoUrl","coverage"]}}},"required":["date","domains"]}}},"required":["brandMentions","brandRankHistory","brandCoverageHistory","brandPositionHistory","brandVisibilityIndex","domainCoverageHistory"]},"competitorBrandsAnalysis":{"type":"object","properties":{"brandMentions":{"type":"array","items":{"type":"object","properties":{"brand":{"type":"string"},"domain":{"type":"string"},"logoUrl":{"type":"string"},"isMainBrand":{"type":"boolean"},"mentions":{"type":"number"},"shareOfVoice":{"type":"number"},"brandCoverage":{"type":"number"},"domainCoverage":{"type":"number"},"domainCitations":{"type":"number"},"averageRank":{"type":"number","nullable":true},"averagePosition":{"type":"number","nullable":true},"visibilityScore":{"type":"number"},"likelihoodToBuy":{"type":"number","nullable":true},"sentiment":{"type":"object","nullable":true,"properties":{"positive":{"type":"number"},"neutral":{"type":"number"},"negative":{"type":"number"},"nss":{"type":"number"}},"required":["positive","neutral","negative","nss"]}},"required":["brand","domain","logoUrl","isMainBrand","mentions","shareOfVoice","brandCoverage","domainCoverage","domainCitations","averageRank","averagePosition","visibilityScore","likelihoodToBuy","sentiment"]}},"brandCoverageHistory":{"type":"array","items":{"type":"object","properties":{"date":{"type":"string"},"brands":{"type":"array","items":{"type":"object","properties":{"brand":{"type":"string"},"isMainBrand":{"type":"boolean"},"logoUrl":{"type":"string"},"coverage":{"type":"number"}},"required":["brand","isMainBrand","logoUrl","coverage"]}}},"required":["date","brands"]}},"domainCoverageHistory":{"type":"array","items":{"type":"object","properties":{"date":{"type":"string"},"domains":{"type":"array","items":{"type":"object","properties":{"domain":{"type":"string"},"isMainBrand":{"type":"boolean"},"logoUrl":{"type":"string"},"coverage":{"type":"number"}},"required":["domain","isMainBrand","logoUrl","coverage"]}}},"required":["date","domains"]}},"brandVisibilityIndex":{"type":"array","items":{"type":"object","properties":{"date":{"type":"string"},"brands":{"type":"array","items":{"type":"object","properties":{"brand":{"type":"string"},"isMainBrand":{"type":"boolean"},"visibilityScore":{"type":"number"},"brandCoverage":{"type":"number"},"likelihoodToBuy":{"type":"number"}},"required":["brand","isMainBrand","visibilityScore","brandCoverage","likelihoodToBuy"]}}},"required":["date","brands"]}}},"required":["brandMentions","brandCoverageHistory","domainCoverageHistory","brandVisibilityIndex"]}},"required":["id","status","isRecalculating","totalPrompts","brand","summary","detectedBrands","allBrandsAnalysis","competitorBrandsAnalysis"],"description":"Brand report stats payload: meta, the tracked brand info, summary metrics, detected source brands, and per-analysis aggregates (all detected brands vs configured competitors)."},"PublicApiBrandReportCitationsList":{"type":"object","properties":{"items":{"type":"array","items":{"$ref":"#/components/schemas/PublicApiBrandReportCitationItem"}},"paging":{"$ref":"#/components/schemas/PublicApiOffsetPaging"}},"required":["items","paging"],"example":{"items":[{"url":"https://www.adidas.com/us/running","domain":"adidas.com","title":"Adidas Running Shoes & Apparel","citations":7469,"prompts":[{"id":"01HXP1DRTM5G8Z2N3KQ7VAW4PA","brandMentioned":1,"engines":["chatgpt","gemini"]}],"isMyBrandDomain":true,"competitors":[{"brand":"Nike"},{"brand":"Asics"},{"brand":"New Balance"}],"brandMentioned":1,"domainCategory":"Brand"}],"paging":{"limit":25,"offset":0}}},"PublicApiBrandReportCitationItem":{"type":"object","properties":{"url":{"type":"string"},"domain":{"type":"string"},"title":{"type":"string"},"citations":{"type":"number"},"prompts":{"type":"array","items":{"$ref":"#/components/schemas/PublicApiBrandReportCitationPrompt"}},"isMyBrandDomain":{"type":"boolean"},"competitors":{"type":"array","items":{"$ref":"#/components/schemas/PublicApiBrandReportCitationCompetitor"}},"brandMentioned":{"type":"number"},"domainCategory":{"type":"string","enum":["Social Media","Community/Forum","Brand","Encyclopedia","News/Media","Blogs/Personal Sites","Government/NGO","Education","Video","Competitor","Others","Unclassified"],"description":"Domain classification.","example":"News/Media"}},"required":["url","domain","title","citations","prompts","brandMentioned","domainCategory"],"example":{"url":"https://www.adidas.com/us/running","domain":"adidas.com","title":"Adidas Running Shoes & Apparel","citations":7469,"prompts":[{"id":"01HXP1DRTM5G8Z2N3KQ7VAW4PA","brandMentioned":1,"engines":["chatgpt","gemini"]}],"isMyBrandDomain":true,"competitors":[{"brand":"Nike"},{"brand":"Asics"},{"brand":"New Balance"}],"brandMentioned":1,"domainCategory":"Brand"}},"PublicApiBrandReportCitationPrompt":{"type":"object","properties":{"id":{"type":"string","minLength":1,"example":"01HX7K2YV9D3M8N0G6Q5R4S3T2"},"brandMentioned":{"type":"number"},"engines":{"type":"array","items":{"type":"string"},"description":"AI engines this citation appeared in."}},"required":["id","brandMentioned","engines"],"example":{"id":"01HXP1DRTM5G8Z2N3KQ7VAW4PA","brandMentioned":1,"engines":["chatgpt","gemini"]}},"PublicApiBrandReportCitationCompetitor":{"type":"object","properties":{"brand":{"type":"string"}},"required":["brand"],"example":{"brand":"Nike"}},"PublicApiOffsetPaging":{"type":"object","properties":{"limit":{"type":"integer","minimum":1},"offset":{"type":"integer","minimum":0}},"required":["limit","offset"],"example":{"limit":25,"offset":0}},"PublicApiBrandReportCitationStatsResponse":{"type":"object","properties":{"domainRank":{"type":"object","properties":{"citations":{"type":"array","items":{"type":"object","properties":{"domain":{"type":"string"},"rank":{"type":"number"},"citations":{"type":"number"},"logoUrl":{"type":"string"},"citationShare":{"type":"number"},"main":{"type":"boolean"}},"required":["domain","rank","citations","logoUrl","citationShare","main"]}}},"required":["citations"]},"domainCitations":{"type":"object","properties":{"current":{"type":"number"},"total":{"type":"number"},"citationShare":{"type":"number"},"mostCitedUrls":{"type":"array","items":{"type":"object","properties":{"url":{"type":"string"},"rank":{"type":"number"},"currentCitations":{"type":"number"},"citationShare":{"type":"number"}},"required":["url","rank","currentCitations","citationShare"]}}},"required":["current","total","citationShare","mostCitedUrls"]},"citations":{"type":"array","items":{"type":"object","properties":{"url":{"type":"string"},"rank":{"type":"number"},"currentCitations":{"type":"number"},"logoUrl":{"type":"string"},"citationShare":{"type":"number"}},"required":["url","rank","currentCitations","logoUrl","citationShare"]}},"competitors":{"type":"array","items":{"type":"object","properties":{"brandDomain":{"type":"string"},"domainCitations":{"type":"object","properties":{"current":{"type":"number"},"total":{"type":"number"},"citationShare":{"type":"number"}},"required":["current","total","citationShare"]}},"required":["brandDomain","domainCitations"]}}},"required":["domainRank","domainCitations","citations","competitors"],"example":{"domainRank":{"citations":[{"domain":"adidas.com","rank":1,"citations":42,"logoUrl":"https://logo.clearbit.com/adidas.com","citationShare":0.42,"main":true}]},"domainCitations":{"current":42,"total":100,"citationShare":0.42,"mostCitedUrls":[{"url":"https://www.adidas.com/us/running","rank":1,"currentCitations":18,"citationShare":0.42}]},"citations":[{"url":"https://www.adidas.com/us/running","rank":1,"currentCitations":18,"logoUrl":"https://logo.clearbit.com/adidas.com","citationShare":0.42}],"competitors":[{"brandDomain":"nike.com","domainCitations":{"current":12,"total":100,"citationShare":0.12}}]}},"PublicApiBrandReportCitationPromptsList":{"type":"object","properties":{"items":{"type":"array","items":{"$ref":"#/components/schemas/PublicApiBrandReportCitationPromptItem"}},"paging":{"$ref":"#/components/schemas/PublicApiOffsetPaging"}},"required":["items","paging"],"example":{"items":[{"id":"01HXP1DRTM5G8Z2N3KQ7VAW4PA","prompt":"best running shoes for flat feet","engines":["chatgpt","perplexity"],"brandMentioned":1}],"paging":{"limit":1,"offset":0}}},"PublicApiBrandReportCitationPromptItem":{"type":"object","properties":{"id":{"type":"string","minLength":1,"example":"01HX7K2YV9D3M8N0G6Q5R4S3T2"},"prompt":{"type":"string"},"engines":{"type":"array","items":{"type":"string"},"description":"AI engines this prompt was issued against."},"brandMentioned":{"type":"number"}},"required":["id","prompt","engines","brandMentioned"],"example":{"id":"01HXP1DRTM5G8Z2N3KQ7VAW4PA","prompt":"best running shoes for flat feet","engines":["chatgpt","perplexity"],"brandMentioned":1}},"PublicApiBrandReportPromptsList":{"type":"object","properties":{"items":{"type":"array","items":{"$ref":"#/components/schemas/PublicApiBrandReportPromptSearchVolumeItem"}},"paging":{"$ref":"#/components/schemas/PublicApiOffsetPaging"}},"required":["items","paging"],"example":{"items":[{"rank":1,"id":"01HXP1DRTM5G8Z2N3KQ7VAW4PA","country":"us","prompt":"best running shoes 2025","volume":12500,"brandMentions":1705,"domainMentions":858,"tags":[{"id":"01HX8AB3CDE4FG5HJ6KL7MN8PQ","name":"Running Shoes","color":"orange"},{"id":"01KEKGEXZFX118K4C2NTMBN0TX","name":"Funnel - BoFu","color":"gold"}],"competitors":[{"brand":"Nike","brandMentions":1331,"domainMentions":66},{"brand":"Asics","brandMentions":891,"domainMentions":77},{"brand":"New Balance","brandMentions":473,"domainMentions":0}]}],"paging":{"limit":25,"offset":0}}},"PublicApiBrandReportPromptSearchVolumeItem":{"type":"object","properties":{"rank":{"type":"number"},"id":{"type":"string","minLength":1,"example":"01HX7K2YV9D3M8N0G6Q5R4S3T2"},"country":{"type":"string"},"prompt":{"type":"string"},"volume":{"type":"number"},"brandMentions":{"type":"number"},"domainMentions":{"type":"number"},"tags":{"type":"array","items":{"$ref":"#/components/schemas/PublicApiBrandReportTag"}},"competitors":{"type":"array","items":{"$ref":"#/components/schemas/PublicApiBrandReportPromptCompetitor"}}},"required":["rank","id","country","prompt","volume","brandMentions","domainMentions"],"example":{"rank":1,"id":"01HXP1DRTM5G8Z2N3KQ7VAW4PA","country":"us","prompt":"best running shoes 2025","volume":12500,"brandMentions":1705,"domainMentions":858,"tags":[{"id":"01HX8AB3CDE4FG5HJ6KL7MN8PQ","name":"Running Shoes","color":"orange"},{"id":"01KEKGEXZFX118K4C2NTMBN0TX","name":"Funnel - BoFu","color":"gold"}],"competitors":[{"brand":"Nike","brandMentions":1331,"domainMentions":66},{"brand":"Asics","brandMentions":891,"domainMentions":77},{"brand":"New Balance","brandMentions":473,"domainMentions":0}]}},"PublicApiBrandReportPromptCompetitor":{"type":"object","properties":{"brand":{"type":"string"},"brandMentions":{"type":"number"},"domainMentions":{"type":"number"}},"required":["brand","brandMentions","domainMentions"],"example":{"brand":"Nike","brandMentions":1331,"domainMentions":66}},"PublicApiBrandReportPromptDetail":{"type":"object","properties":{"id":{"type":"string","minLength":1,"example":"01HX7K2YV9D3M8N0G6Q5R4S3T2"},"reportId":{"type":"string","minLength":1,"example":"01HX7K2YV9D3M8N0G6Q5R4S3T2"},"prompt":{"type":"string"},"intentVolume":{"type":"number"},"brandCoverageHistory":{"type":"array","items":{"type":"object","properties":{"brand":{"type":"string"},"coverage":{"type":"number"},"date":{"type":"string"}},"required":["brand","coverage","date"]}},"brandRank":{"type":"array","items":{"type":"object","properties":{"brand":{"type":"string"},"rank":{"type":"number"},"mentions":{"type":"number"},"brandCoverage":{"type":"number"},"sentiment":{"type":"object","properties":{"positive":{"type":"number"},"neutral":{"type":"number"},"negative":{"type":"number"},"nss":{"type":"number"}},"required":["positive","neutral","negative","nss"]}},"required":["brand","rank","mentions","brandCoverage"]}},"domainCategories":{"type":"array","items":{"type":"object","properties":{"category":{"type":"string"},"value":{"type":"number"}},"required":["category","value"]}},"brandReports":{"type":"array","items":{"$ref":"#/components/schemas/PublicApiBrandReportPromptBrandReportRef"}},"tags":{"type":"array","items":{"$ref":"#/components/schemas/PublicApiBrandReportTag"}}},"required":["id","reportId","prompt","intentVolume","brandCoverageHistory","brandRank","domainCategories","brandReports","tags"],"example":{"id":"01HXP1DRTM5G8Z2N3KQ7VAW4PA","reportId":"01HXBR1DGM5XY8Z2N3KQ7VAW4P","prompt":"best running shoes 2025","intentVolume":12500,"brandCoverageHistory":[{"brand":"Adidas","coverage":0.42,"date":"2025-01-15"}],"brandRank":[{"brand":"Adidas","rank":1,"mentions":1705,"brandCoverage":0.42,"sentiment":{"positive":0.6,"neutral":0.3,"negative":0.1,"nss":0.5}}],"domainCategories":[{"category":"News/Media","value":18},{"category":"Brand","value":7}],"brandReports":[{"id":"01HXBR1DGM5XY8Z2N3KQ7VAW4P","brand":"Adidas","brandDomain":"adidas.com","reportTitle":"Adidas Visibility Report"}],"tags":[{"id":"01HX8AB3CDE4FG5HJ6KL7MN8PQ","name":"Running Shoes","color":"orange"}]}},"PublicApiBrandReportPromptBrandReportRef":{"type":"object","properties":{"id":{"type":"string","minLength":1,"example":"01HX7K2YV9D3M8N0G6Q5R4S3T2"},"brand":{"type":"string"},"brandDomain":{"type":"string"},"reportTitle":{"type":"string"}},"required":["id","brand","brandDomain"],"example":{"id":"01HXBR1DGM5XY8Z2N3KQ7VAW4P","brand":"Adidas","brandDomain":"adidas.com","reportTitle":"Adidas Visibility Report"}},"PublicApiBrandReportPromptAiResponsesList":{"type":"object","properties":{"items":{"type":"array","items":{"$ref":"#/components/schemas/PublicApiBrandReportPromptAiResponseItem"}},"paging":{"$ref":"#/components/schemas/PublicApiCursorPageInfo"}},"required":["items","paging"],"example":{"items":[{"runId":"01HXRUN5XY8Z2N3KQ7VAW4PAEX","runDate":"2025-01-15T08:00:00.000Z","engine":"chatgpt","state":"completed","content":"Adidas, Nike and Asics are widely cited as top picks for 2025...","overviewAvailable":true,"brandMentions":[{"brand":"Adidas","isMainBrand":true,"mentions":4},{"brand":"Nike","isMainBrand":false,"mentions":3}],"citations":[{"title":"Best Running Shoes of 2025","link":"https://www.runnersworld.com/gear/a40081820/best-running-shoes-2025/","rank":1}]}],"paging":{"nextCursor":null,"hasMore":false}}},"PublicApiBrandReportPromptAiResponseItem":{"type":"object","properties":{"runId":{"type":"string","minLength":1,"example":"01HX7K2YV9D3M8N0G6Q5R4S3T2"},"runDate":{"type":"string"},"engine":{"type":"string","description":"AI engine that produced this response."},"state":{"type":"string"},"content":{"type":"string"},"overviewAvailable":{"type":"boolean"},"brandMentions":{"type":"array","items":{"type":"object","properties":{"brand":{"type":"string"},"isMainBrand":{"type":"boolean"},"mentions":{"type":"number"}},"required":["brand","isMainBrand","mentions"]}},"citations":{"type":"array","items":{"type":"object","properties":{"title":{"type":"string"},"link":{"type":"string"},"rank":{"type":"number"}},"required":["title","link","rank"]}}},"required":["runId","runDate","engine","state","content","overviewAvailable","brandMentions","citations"],"example":{"runId":"01HXRUN5XY8Z2N3KQ7VAW4PAEX","runDate":"2025-01-15T08:00:00.000Z","engine":"chatgpt","state":"completed","content":"Adidas, Nike and Asics are widely cited as top picks for 2025...","overviewAvailable":true,"brandMentions":[{"brand":"Adidas","isMainBrand":true,"mentions":4},{"brand":"Nike","isMainBrand":false,"mentions":3}],"citations":[{"title":"Best Running Shoes of 2025","link":"https://www.runnersworld.com/gear/a40081820/best-running-shoes-2025/","rank":1}]}},"PublicApiBrandReportRecommendationsList":{"type":"object","properties":{"items":{"type":"array","items":{"$ref":"#/components/schemas/PublicApiBrandReportRecommendationItem"}},"paging":{"$ref":"#/components/schemas/PublicApiCursorPageInfo"}},"required":["items","paging"],"example":{"items":[{"id":"1072ee8791164402a29207d96bfb036ca43e85dd1c0678e8899cb0caa96f655c","engine":"chatgpt","type":"content_partnership_opportunities","group":"off_page","priority":6,"score":261,"state":"suggested","data":{"url":"https://www.runnersworld.com/gear/a40081820/best-running-shoes-2025/","title":"Best Running Shoes of 2025, Tested & Reviewed","domain":"runnersworld.com","domainCategory":"News/Media","mentionedCompetitors":["Nike","Asics","New Balance"],"citations":7,"prompts":[{"promptId":"01HXP1DRTM5G8Z2N3KQ7VAW4PA","prompt":"best running shoes 2025"}],"country":"us","service":"chatgpt","type":"content_partnership_opportunities"}}],"paging":{"nextCursor":null,"hasMore":false}}},"PublicApiBrandReportRecommendationItem":{"type":"object","properties":{"id":{"type":"string","minLength":1,"example":"01HX7K2YV9D3M8N0G6Q5R4S3T2"},"engine":{"type":"string"},"type":{"type":"string","enum":["competitors_count","prompts_count","prompt_diversity_branded_prompts","prompt_diversity_tofu","crawlability_check","brand_mention_check","content_partnership_opportunities","reddit_thread_opportunities","get_mentioned_on_existing_media_press_release","create_youtube_videos","collaborate_with_youtubers","drive_conversation_on_social_media_topics","improve_wikipedia_presence","media_press_release_say_thank_you","write_press_release","create_content_on_page","improve_existing_content"],"description":"Recommendation rule identifier. Determines the shape of `data`."},"checkerType":{"type":"string","enum":["prompts_sufficiency","prompt_diversity","crawlability","entity"],"description":"Higher-level checker that produced the recommendation."},"group":{"type":"string","enum":["general","off_page","on_page"],"description":"Recommendation surface group."},"priority":{"anyOf":[{"type":"string"},{"type":"number"}]},"score":{"type":"number"},"state":{"type":"string","enum":["suggested","todo","archived","removed"]},"status":{"type":"string","enum":["notStarted","inProgress","complete"]},"todoId":{"type":"string"},"data":{"anyOf":[{"$ref":"#/components/schemas/PublicApiBrandReportRecommendationPromptsCountData"},{"$ref":"#/components/schemas/PublicApiBrandReportRecommendationCompetitorsCountData"},{"$ref":"#/components/schemas/PublicApiBrandReportRecommendationPromptDiversityBrandedPromptsData"},{"$ref":"#/components/schemas/PublicApiBrandReportRecommendationPromptDiversityTofuData"},{"$ref":"#/components/schemas/PublicApiBrandReportRecommendationCrawlabilityCheckData"},{"$ref":"#/components/schemas/PublicApiBrandReportRecommendationBrandMentionCheckData"},{"$ref":"#/components/schemas/PublicApiBrandReportRecommendationContentPartnershipOpportunitiesData"},{"$ref":"#/components/schemas/PublicApiBrandReportRecommendationRedditThreadOpportunitiesData"},{"$ref":"#/components/schemas/PublicApiBrandReportRecommendationGetMentionedOnExistingMediaPressReleaseData"},{"$ref":"#/components/schemas/PublicApiBrandReportRecommendationCreateYoutubeVideosData"},{"$ref":"#/components/schemas/PublicApiBrandReportRecommendationCollaborateWithYoutubersData"},{"$ref":"#/components/schemas/PublicApiBrandReportRecommendationDriveConversationOnSocialMediaTopicsData"},{"$ref":"#/components/schemas/PublicApiBrandReportRecommendationImproveWikipediaPresenceData"},{"$ref":"#/components/schemas/PublicApiBrandReportRecommendationMediaPressReleaseSayThankYouData"},{"$ref":"#/components/schemas/PublicApiBrandReportRecommendationWritePressReleaseData"},{"$ref":"#/components/schemas/PublicApiBrandReportRecommendationCreateContentOnPageData"},{"$ref":"#/components/schemas/PublicApiBrandReportRecommendationImproveExistingContentData"}],"description":"Recommendation payload. Shape is determined by the parent `type` field (e.g. `content_partnership_opportunities` → `PublicApiBrandReportRecommendationContentPartnershipOpportunitiesData`). May also include `country` and `service` keys describing the scope."}},"required":["id"],"example":{"id":"1072ee8791164402a29207d96bfb036ca43e85dd1c0678e8899cb0caa96f655c","engine":"chatgpt","type":"content_partnership_opportunities","group":"off_page","priority":6,"score":261,"state":"suggested","data":{"url":"https://www.runnersworld.com/gear/a40081820/best-running-shoes-2025/","title":"Best Running Shoes of 2025, Tested & Reviewed","domain":"runnersworld.com","domainCategory":"News/Media","mentionedCompetitors":["Nike","Asics","New Balance"],"citations":7,"prompts":[{"promptId":"01HXP1DRTM5G8Z2N3KQ7VAW4PA","prompt":"best running shoes 2025"}],"country":"us","service":"chatgpt","type":"content_partnership_opportunities"}}},"PublicApiBrandReportRecommendationPromptsCountData":{"type":"object","properties":{"totalPrompts":{"type":"number"},"country":{"type":"string","description":"Optional. ISO country scope (e.g. `us`)."},"service":{"type":"string","description":"Optional. AI engine scope; `all` indicates cross-engine."},"type":{"type":"string","enum":["competitors_count","prompts_count","prompt_diversity_branded_prompts","prompt_diversity_tofu","crawlability_check","brand_mention_check","content_partnership_opportunities","reddit_thread_opportunities","get_mentioned_on_existing_media_press_release","create_youtube_videos","collaborate_with_youtubers","drive_conversation_on_social_media_topics","improve_wikipedia_presence","media_press_release_say_thank_you","write_press_release","create_content_on_page","improve_existing_content"],"description":"Optional. Duplicates the parent `type` for convenience."}},"required":["totalPrompts"],"additionalProperties":{"nullable":true},"example":{"totalPrompts":6,"country":"us","service":"all","type":"prompts_count"}},"PublicApiBrandReportRecommendationCompetitorsCountData":{"type":"object","properties":{"totalCompetitors":{"type":"number"},"reportUuid":{"type":"string"},"country":{"type":"string","description":"Optional. ISO country scope (e.g. `us`)."},"service":{"type":"string","description":"Optional. AI engine scope; `all` indicates cross-engine."},"type":{"type":"string","enum":["competitors_count","prompts_count","prompt_diversity_branded_prompts","prompt_diversity_tofu","crawlability_check","brand_mention_check","content_partnership_opportunities","reddit_thread_opportunities","get_mentioned_on_existing_media_press_release","create_youtube_videos","collaborate_with_youtubers","drive_conversation_on_social_media_topics","improve_wikipedia_presence","media_press_release_say_thank_you","write_press_release","create_content_on_page","improve_existing_content"],"description":"Optional. Duplicates the parent `type` for convenience."}},"required":["totalCompetitors","reportUuid"],"additionalProperties":{"nullable":true},"example":{"totalCompetitors":3,"reportUuid":"ai-report-uuid","country":"us","service":"all","type":"competitors_count"}},"PublicApiBrandReportRecommendationPromptDiversityBrandedPromptsData":{"type":"object","properties":{"totalPrompts":{"type":"number"},"brandedCount":{"type":"number"},"brandedPrompts":{"type":"array","items":{"type":"object","properties":{"promptId":{"type":"string","minLength":1,"example":"01HX7K2YV9D3M8N0G6Q5R4S3T2"},"prompt":{"type":"string","description":"Optional. Full prompt text."}},"required":["promptId"],"additionalProperties":{"nullable":true}}},"country":{"type":"string","description":"Optional. ISO country scope (e.g. `us`)."},"service":{"type":"string","description":"Optional. AI engine scope; `all` indicates cross-engine."},"type":{"type":"string","enum":["competitors_count","prompts_count","prompt_diversity_branded_prompts","prompt_diversity_tofu","crawlability_check","brand_mention_check","content_partnership_opportunities","reddit_thread_opportunities","get_mentioned_on_existing_media_press_release","create_youtube_videos","collaborate_with_youtubers","drive_conversation_on_social_media_topics","improve_wikipedia_presence","media_press_release_say_thank_you","write_press_release","create_content_on_page","improve_existing_content"],"description":"Optional. Duplicates the parent `type` for convenience."}},"required":["brandedCount","brandedPrompts"],"additionalProperties":{"nullable":true},"example":{"totalPrompts":87,"brandedCount":30,"brandedPrompts":[{"promptId":"01HXP1DRTM5G8Z2N3KQ7VAW4PA","prompt":"Acme reviews"}],"country":"us","service":"all","type":"prompt_diversity_branded_prompts"}},"PublicApiBrandReportRecommendationPromptDiversityTofuData":{"type":"object","properties":{"totalPrompts":{"type":"number"},"tofuCount":{"type":"number"},"tofuPercentage":{"type":"number"},"country":{"type":"string","description":"Optional. ISO country scope (e.g. `us`)."},"service":{"type":"string","description":"Optional. AI engine scope; `all` indicates cross-engine."},"type":{"type":"string","enum":["competitors_count","prompts_count","prompt_diversity_branded_prompts","prompt_diversity_tofu","crawlability_check","brand_mention_check","content_partnership_opportunities","reddit_thread_opportunities","get_mentioned_on_existing_media_press_release","create_youtube_videos","collaborate_with_youtubers","drive_conversation_on_social_media_topics","improve_wikipedia_presence","media_press_release_say_thank_you","write_press_release","create_content_on_page","improve_existing_content"],"description":"Optional. Duplicates the parent `type` for convenience."}},"required":["totalPrompts","tofuCount","tofuPercentage"],"additionalProperties":{"nullable":true},"example":{"totalPrompts":87,"tofuCount":25,"tofuPercentage":28.7,"country":"us","service":"all","type":"prompt_diversity_tofu"}},"PublicApiBrandReportRecommendationCrawlabilityCheckData":{"type":"object","properties":{"engines":{"type":"array","items":{"type":"string"}},"country":{"type":"string","description":"Optional. ISO country scope (e.g. `us`)."},"service":{"type":"string","description":"Optional. AI engine scope; `all` indicates cross-engine."},"type":{"type":"string","enum":["competitors_count","prompts_count","prompt_diversity_branded_prompts","prompt_diversity_tofu","crawlability_check","brand_mention_check","content_partnership_opportunities","reddit_thread_opportunities","get_mentioned_on_existing_media_press_release","create_youtube_videos","collaborate_with_youtubers","drive_conversation_on_social_media_topics","improve_wikipedia_presence","media_press_release_say_thank_you","write_press_release","create_content_on_page","improve_existing_content"],"description":"Optional. Duplicates the parent `type` for convenience."}},"required":["engines"],"additionalProperties":{"nullable":true},"example":{"engines":["chatgpt","gemini"],"country":"us","service":"all","type":"crawlability_check"}},"PublicApiBrandReportRecommendationBrandMentionCheckData":{"type":"object","properties":{"engines":{"type":"array","items":{"type":"string"}},"country":{"type":"string","description":"Optional. ISO country scope (e.g. `us`)."},"service":{"type":"string","description":"Optional. AI engine scope; `all` indicates cross-engine."},"type":{"type":"string","enum":["competitors_count","prompts_count","prompt_diversity_branded_prompts","prompt_diversity_tofu","crawlability_check","brand_mention_check","content_partnership_opportunities","reddit_thread_opportunities","get_mentioned_on_existing_media_press_release","create_youtube_videos","collaborate_with_youtubers","drive_conversation_on_social_media_topics","improve_wikipedia_presence","media_press_release_say_thank_you","write_press_release","create_content_on_page","improve_existing_content"],"description":"Optional. Duplicates the parent `type` for convenience."}},"required":["engines"],"additionalProperties":{"nullable":true},"example":{"engines":["chatgpt","gemini"],"country":"us","service":"chatgpt","type":"brand_mention_check"}},"PublicApiBrandReportRecommendationContentPartnershipOpportunitiesData":{"type":"object","properties":{"url":{"type":"string"},"title":{"type":"string"},"domain":{"type":"string"},"domainCategory":{"type":"string"},"mentionedCompetitors":{"type":"array","items":{"type":"string"}},"citations":{"type":"number"},"prompts":{"type":"array","items":{"type":"object","properties":{"promptId":{"type":"string","minLength":1,"example":"01HX7K2YV9D3M8N0G6Q5R4S3T2"},"prompt":{"type":"string","description":"Optional. Full prompt text."}},"required":["promptId"],"additionalProperties":{"nullable":true}}},"country":{"type":"string","description":"Optional. ISO country scope (e.g. `us`)."},"service":{"type":"string","description":"Optional. AI engine scope; `all` indicates cross-engine."},"type":{"type":"string","enum":["competitors_count","prompts_count","prompt_diversity_branded_prompts","prompt_diversity_tofu","crawlability_check","brand_mention_check","content_partnership_opportunities","reddit_thread_opportunities","get_mentioned_on_existing_media_press_release","create_youtube_videos","collaborate_with_youtubers","drive_conversation_on_social_media_topics","improve_wikipedia_presence","media_press_release_say_thank_you","write_press_release","create_content_on_page","improve_existing_content"],"description":"Optional. Duplicates the parent `type` for convenience."}},"required":["url","domain","domainCategory","mentionedCompetitors","citations","prompts"],"additionalProperties":{"nullable":true},"example":{"url":"https://www.runnersworld.com/gear/a40081820/best-running-shoes-2025/","title":"Best Running Shoes of 2025, Tested & Reviewed","domain":"runnersworld.com","domainCategory":"News/Media","mentionedCompetitors":["Nike","Asics","New Balance"],"citations":7,"prompts":[{"promptId":"01HXP1DRTM5G8Z2N3KQ7VAW4PA","prompt":"best running shoes 2025"}],"country":"us","service":"chatgpt","type":"content_partnership_opportunities"}},"PublicApiBrandReportRecommendationRedditThreadOpportunitiesData":{"type":"object","properties":{"url":{"type":"string"},"title":{"type":"string"},"subreddit":{"type":"string"},"mentionedCompetitors":{"type":"array","items":{"type":"string"}},"prompts":{"type":"array","items":{"type":"object","properties":{"promptId":{"type":"string","minLength":1,"example":"01HX7K2YV9D3M8N0G6Q5R4S3T2"},"prompt":{"type":"string","description":"Optional. Full prompt text."}},"required":["promptId"],"additionalProperties":{"nullable":true}}},"citations":{"type":"number"},"country":{"type":"string","description":"Optional. ISO country scope (e.g. `us`)."},"service":{"type":"string","description":"Optional. AI engine scope; `all` indicates cross-engine."},"type":{"type":"string","enum":["competitors_count","prompts_count","prompt_diversity_branded_prompts","prompt_diversity_tofu","crawlability_check","brand_mention_check","content_partnership_opportunities","reddit_thread_opportunities","get_mentioned_on_existing_media_press_release","create_youtube_videos","collaborate_with_youtubers","drive_conversation_on_social_media_topics","improve_wikipedia_presence","media_press_release_say_thank_you","write_press_release","create_content_on_page","improve_existing_content"],"description":"Optional. Duplicates the parent `type` for convenience."}},"required":["url","mentionedCompetitors","prompts","citations"],"additionalProperties":{"nullable":true},"example":{"url":"https://reddit.com/r/RunningShoeGeeks/comments/example","title":"Best running shoes 2025 megathread","subreddit":"RunningShoeGeeks","mentionedCompetitors":["Nike","Asics"],"prompts":[{"promptId":"01HXP1DRTM5G8Z2N3KQ7VAW4PA","prompt":"best running shoes reddit"}],"citations":4,"country":"us","service":"chatgpt","type":"reddit_thread_opportunities"}},"PublicApiBrandReportRecommendationGetMentionedOnExistingMediaPressReleaseData":{"type":"object","properties":{"url":{"type":"string"},"title":{"type":"string"},"domain":{"type":"string"},"mentionedCompetitors":{"type":"array","items":{"type":"string"}},"competitorMentionsTotal":{"type":"number"},"citations":{"type":"number"},"prompts":{"type":"array","items":{"type":"object","properties":{"promptId":{"type":"string","minLength":1,"example":"01HX7K2YV9D3M8N0G6Q5R4S3T2"},"prompt":{"type":"string","description":"Optional. Full prompt text."}},"required":["promptId"],"additionalProperties":{"nullable":true}}},"country":{"type":"string","description":"Optional. ISO country scope (e.g. `us`)."},"service":{"type":"string","description":"Optional. AI engine scope; `all` indicates cross-engine."},"type":{"type":"string","enum":["competitors_count","prompts_count","prompt_diversity_branded_prompts","prompt_diversity_tofu","crawlability_check","brand_mention_check","content_partnership_opportunities","reddit_thread_opportunities","get_mentioned_on_existing_media_press_release","create_youtube_videos","collaborate_with_youtubers","drive_conversation_on_social_media_topics","improve_wikipedia_presence","media_press_release_say_thank_you","write_press_release","create_content_on_page","improve_existing_content"],"description":"Optional. Duplicates the parent `type` for convenience."}},"required":["url","domain","mentionedCompetitors","citations"],"additionalProperties":{"nullable":true},"example":{"url":"https://example.com/press/best-of-2025","title":"Best running brands of 2025","domain":"example.com","mentionedCompetitors":["Nike"],"competitorMentionsTotal":3,"citations":2,"prompts":[{"promptId":"01HXP1DRTM5G8Z2N3KQ7VAW4PA","prompt":"best running brands"}],"country":"us","service":"chatgpt","type":"get_mentioned_on_existing_media_press_release"}},"PublicApiBrandReportRecommendationCreateYoutubeVideosData":{"type":"object","properties":{"url":{"type":"string"},"title":{"type":"string"},"domain":{"type":"string"},"citations":{"type":"number"},"mentionedCompetitors":{"type":"array","items":{"type":"string"}},"country":{"type":"string","description":"Optional. ISO country scope (e.g. `us`)."},"service":{"type":"string","description":"Optional. AI engine scope; `all` indicates cross-engine."},"type":{"type":"string","enum":["competitors_count","prompts_count","prompt_diversity_branded_prompts","prompt_diversity_tofu","crawlability_check","brand_mention_check","content_partnership_opportunities","reddit_thread_opportunities","get_mentioned_on_existing_media_press_release","create_youtube_videos","collaborate_with_youtubers","drive_conversation_on_social_media_topics","improve_wikipedia_presence","media_press_release_say_thank_you","write_press_release","create_content_on_page","improve_existing_content"],"description":"Optional. Duplicates the parent `type` for convenience."}},"required":["url","domain","citations","mentionedCompetitors"],"additionalProperties":{"nullable":true},"example":{"url":"https://youtube.com/watch?v=example","title":"Top running shoes 2025","domain":"youtube.com","citations":6,"mentionedCompetitors":["Nike"],"country":"us","service":"chatgpt","type":"create_youtube_videos"}},"PublicApiBrandReportRecommendationCollaborateWithYoutubersData":{"type":"object","properties":{"url":{"type":"string"},"title":{"type":"string"},"channelTitle":{"type":"string"},"citations":{"type":"number"},"country":{"type":"string","description":"Optional. ISO country scope (e.g. `us`)."},"service":{"type":"string","description":"Optional. AI engine scope; `all` indicates cross-engine."},"type":{"type":"string","enum":["competitors_count","prompts_count","prompt_diversity_branded_prompts","prompt_diversity_tofu","crawlability_check","brand_mention_check","content_partnership_opportunities","reddit_thread_opportunities","get_mentioned_on_existing_media_press_release","create_youtube_videos","collaborate_with_youtubers","drive_conversation_on_social_media_topics","improve_wikipedia_presence","media_press_release_say_thank_you","write_press_release","create_content_on_page","improve_existing_content"],"description":"Optional. Duplicates the parent `type` for convenience."}},"required":["url","citations"],"additionalProperties":{"nullable":true},"example":{"url":"https://youtube.com/@reviewer","title":"Running shoe reviewer","channelTitle":"ReviewerChannel","citations":5,"country":"us","service":"chatgpt","type":"collaborate_with_youtubers"}},"PublicApiBrandReportRecommendationDriveConversationOnSocialMediaTopicsData":{"type":"object","properties":{"url":{"type":"string"},"title":{"type":"string"},"domain":{"type":"string"},"citations":{"type":"number"},"mentionedCompetitors":{"type":"array","items":{"type":"string"}},"country":{"type":"string","description":"Optional. ISO country scope (e.g. `us`)."},"service":{"type":"string","description":"Optional. AI engine scope; `all` indicates cross-engine."},"type":{"type":"string","enum":["competitors_count","prompts_count","prompt_diversity_branded_prompts","prompt_diversity_tofu","crawlability_check","brand_mention_check","content_partnership_opportunities","reddit_thread_opportunities","get_mentioned_on_existing_media_press_release","create_youtube_videos","collaborate_with_youtubers","drive_conversation_on_social_media_topics","improve_wikipedia_presence","media_press_release_say_thank_you","write_press_release","create_content_on_page","improve_existing_content"],"description":"Optional. Duplicates the parent `type` for convenience."}},"required":["url","domain","citations","mentionedCompetitors"],"additionalProperties":{"nullable":true},"example":{"url":"https://x.com/influencer/status/example","title":"Best running shoes 2025","domain":"x.com","citations":4,"mentionedCompetitors":["Nike"],"country":"us","service":"chatgpt","type":"drive_conversation_on_social_media_topics"}},"PublicApiBrandReportRecommendationImproveWikipediaPresenceData":{"type":"object","properties":{"url":{"type":"string"},"title":{"type":"string"},"domain":{"type":"string"},"citations":{"type":"number"},"country":{"type":"string","description":"Optional. ISO country scope (e.g. `us`)."},"service":{"type":"string","description":"Optional. AI engine scope; `all` indicates cross-engine."},"type":{"type":"string","enum":["competitors_count","prompts_count","prompt_diversity_branded_prompts","prompt_diversity_tofu","crawlability_check","brand_mention_check","content_partnership_opportunities","reddit_thread_opportunities","get_mentioned_on_existing_media_press_release","create_youtube_videos","collaborate_with_youtubers","drive_conversation_on_social_media_topics","improve_wikipedia_presence","media_press_release_say_thank_you","write_press_release","create_content_on_page","improve_existing_content"],"description":"Optional. Duplicates the parent `type` for convenience."}},"required":["url","domain","citations"],"additionalProperties":{"nullable":true},"example":{"url":"https://en.wikipedia.org/wiki/Running_shoe","title":"Running shoe","domain":"en.wikipedia.org","citations":3,"country":"us","service":"chatgpt","type":"improve_wikipedia_presence"}},"PublicApiBrandReportRecommendationMediaPressReleaseSayThankYouData":{"type":"object","properties":{"url":{"type":"string"},"title":{"type":"string"},"domain":{"type":"string"},"citations":{"type":"number"},"prompts":{"type":"array","items":{"type":"object","properties":{"promptId":{"type":"string","minLength":1,"example":"01HX7K2YV9D3M8N0G6Q5R4S3T2"},"prompt":{"type":"string","description":"Optional. Full prompt text."}},"required":["promptId"],"additionalProperties":{"nullable":true}}},"country":{"type":"string","description":"Optional. ISO country scope (e.g. `us`)."},"service":{"type":"string","description":"Optional. AI engine scope; `all` indicates cross-engine."},"type":{"type":"string","enum":["competitors_count","prompts_count","prompt_diversity_branded_prompts","prompt_diversity_tofu","crawlability_check","brand_mention_check","content_partnership_opportunities","reddit_thread_opportunities","get_mentioned_on_existing_media_press_release","create_youtube_videos","collaborate_with_youtubers","drive_conversation_on_social_media_topics","improve_wikipedia_presence","media_press_release_say_thank_you","write_press_release","create_content_on_page","improve_existing_content"],"description":"Optional. Duplicates the parent `type` for convenience."}},"required":["url","domain","citations"],"additionalProperties":{"nullable":true},"example":{"url":"https://example.com/article","title":"Acme makes the list","domain":"example.com","citations":4,"country":"us","service":"chatgpt","type":"media_press_release_say_thank_you"}},"PublicApiBrandReportRecommendationWritePressReleaseData":{"type":"object","properties":{"promptId":{"type":"string","minLength":1,"example":"01HX7K2YV9D3M8N0G6Q5R4S3T2"},"prompt":{"type":"string"},"competitorMentionsTotal":{"type":"number"},"headlineProposal":{"type":"string"},"country":{"type":"string","description":"Optional. ISO country scope (e.g. `us`)."},"service":{"type":"string","description":"Optional. AI engine scope; `all` indicates cross-engine."},"type":{"type":"string","enum":["competitors_count","prompts_count","prompt_diversity_branded_prompts","prompt_diversity_tofu","crawlability_check","brand_mention_check","content_partnership_opportunities","reddit_thread_opportunities","get_mentioned_on_existing_media_press_release","create_youtube_videos","collaborate_with_youtubers","drive_conversation_on_social_media_topics","improve_wikipedia_presence","media_press_release_say_thank_you","write_press_release","create_content_on_page","improve_existing_content"],"description":"Optional. Duplicates the parent `type` for convenience."}},"required":["promptId","competitorMentionsTotal"],"additionalProperties":{"nullable":true},"example":{"promptId":"01HXP1DRTM5G8Z2N3KQ7VAW4PA","prompt":"new product launch","competitorMentionsTotal":6,"headlineProposal":"Acme launches new flagship shoe","country":"us","service":"chatgpt","type":"write_press_release"}},"PublicApiBrandReportRecommendationCreateContentOnPageData":{"type":"object","properties":{"promptId":{"type":"string","minLength":1,"example":"01HX7K2YV9D3M8N0G6Q5R4S3T2"},"prompt":{"type":"string"},"url":{"type":"string"},"title":{"type":"string"},"headlineSuggestion":{"type":"string"},"country":{"type":"string","description":"Optional. ISO country scope (e.g. `us`)."},"service":{"type":"string","description":"Optional. AI engine scope; `all` indicates cross-engine."},"type":{"type":"string","enum":["competitors_count","prompts_count","prompt_diversity_branded_prompts","prompt_diversity_tofu","crawlability_check","brand_mention_check","content_partnership_opportunities","reddit_thread_opportunities","get_mentioned_on_existing_media_press_release","create_youtube_videos","collaborate_with_youtubers","drive_conversation_on_social_media_topics","improve_wikipedia_presence","media_press_release_say_thank_you","write_press_release","create_content_on_page","improve_existing_content"],"description":"Optional. Duplicates the parent `type` for convenience."}},"required":["promptId","url"],"additionalProperties":{"nullable":true},"example":{"promptId":"01HXP1DRTM5G8Z2N3KQ7VAW4PA","prompt":"compare Acme to BetaCorp","url":"https://acme.com/pages/pricing","title":"Acme pricing","headlineSuggestion":"How Acme pricing compares to BetaCorp","country":"us","service":"chatgpt","type":"create_content_on_page"}},"PublicApiBrandReportRecommendationImproveExistingContentData":{"type":"object","properties":{"promptId":{"type":"string","minLength":1,"example":"01HX7K2YV9D3M8N0G6Q5R4S3T2"},"prompt":{"type":"string"},"intent":{"type":"string"},"urls":{"type":"array","items":{"type":"object","properties":{"url":{"type":"string"},"title":{"type":"string"}},"required":["url"],"additionalProperties":{"nullable":true}}},"urlsWithCitations":{"type":"array","items":{"type":"object","properties":{"url":{"type":"string"},"title":{"type":"string"},"citations":{"type":"number"}},"required":["url","citations"],"additionalProperties":{"nullable":true}}},"country":{"type":"string","description":"Optional. ISO country scope (e.g. `us`)."},"service":{"type":"string","description":"Optional. AI engine scope; `all` indicates cross-engine."},"type":{"type":"string","enum":["competitors_count","prompts_count","prompt_diversity_branded_prompts","prompt_diversity_tofu","crawlability_check","brand_mention_check","content_partnership_opportunities","reddit_thread_opportunities","get_mentioned_on_existing_media_press_release","create_youtube_videos","collaborate_with_youtubers","drive_conversation_on_social_media_topics","improve_wikipedia_presence","media_press_release_say_thank_you","write_press_release","create_content_on_page","improve_existing_content"],"description":"Optional. Duplicates the parent `type` for convenience."}},"required":["promptId","intent","urls","urlsWithCitations"],"additionalProperties":{"nullable":true},"example":{"promptId":"01HXP1DRTM5G8Z2N3KQ7VAW4PA","prompt":"why choose Acme","intent":"comparison","urls":[{"url":"https://acme.com/blog/post","title":"Why Acme"}],"urlsWithCitations":[{"url":"https://acme.com/blog/post","title":"Why Acme","citations":2}],"country":"us","service":"chatgpt","type":"improve_existing_content"}},"AccountInfoResponse":{"type":"object","properties":{"subscriptionPlan":{"type":"string","nullable":true,"enum":["trial","lite","standard","premium","custom",null],"description":"The team's subscription plan. \"trial\" while the team is in trial; \"custom\" for teams whose plan is not one of the standard tiers.","example":"standard"},"subscriptionEndDate":{"type":"string","nullable":true,"format":"date-time","description":"When the current subscription (or trial) ends. Null when no end date is set.","example":"2026-06-19T00:00:00.000Z"},"promptsUsedCount":{"type":"integer","minimum":0,"example":142},"promptsMaxCount":{"type":"integer","minimum":0,"example":500},"geoAuditUsedCount":{"type":"integer","minimum":0,"example":7},"geoAuditMaxCount":{"type":"integer","minimum":0,"example":25},"apiRequestsUsedCount":{"type":"integer","minimum":0,"example":38},"apiRequestsMaxCount":{"type":"integer","minimum":0,"example":1500}},"required":["subscriptionPlan","subscriptionEndDate","promptsUsedCount","promptsMaxCount","geoAuditUsedCount","geoAuditMaxCount","apiRequestsUsedCount","apiRequestsMaxCount"]}},"parameters":{}},"paths":{"/v1/engines":{"get":{"tags":["Engines"],"summary":"List AI engines and supported countries","security":[{"BearerAuth":[]}],"parameters":[{"schema":{"type":"string","description":"Filter by country code (e.g. \"us\", \"uk\", \"de\").","example":"us"},"required":false,"description":"Filter by country code (e.g. \"us\", \"uk\", \"de\").","name":"country","in":"query"},{"schema":{"type":"string","enum":["chatgpt","google","perplexity","copilot","google_ai_mode","gemini"],"description":"Optional. Filter results to a single AI engine.","example":"chatgpt"},"required":false,"description":"Optional. Filter results to a single AI engine.","name":"engine","in":"query"}],"responses":{"200":{"description":"A list of engine configurations per country.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/EnginesResponse"}}}},"400":{"description":"Validation failed.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/PublicApiValidationErrorResponse"}}}},"401":{"description":"Unauthorized.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/PublicApiErrorResponse"}}}},"403":{"description":"Forbidden.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/PublicApiErrorResponse"}}}}}}},"/v1/workspaces":{"get":{"tags":["Workspaces"],"summary":"List workspaces","security":[{"BearerAuth":[]}],"parameters":[{"schema":{"type":"string","minLength":1,"description":"Optional. Pagination cursor — pass back the `nextCursor` value from a previous response. Omit to fetch the first page."},"required":false,"description":"Optional. Pagination cursor — pass back the `nextCursor` value from a previous response. Omit to fetch the first page.","name":"cursor","in":"query"}],"responses":{"200":{"description":"A list of workspaces.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/PublicApiWorkspacesList"}}}},"400":{"description":"Validation failed.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/PublicApiValidationErrorResponse"}}}},"401":{"description":"Unauthorized.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/PublicApiErrorResponse"}}}},"403":{"description":"Forbidden.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/PublicApiErrorResponse"}}}}}}},"/v1/workspaces/{id}/tags":{"get":{"tags":["Workspaces"],"summary":"List tags for a workspace","security":[{"BearerAuth":[]}],"parameters":[{"schema":{"type":"string","minLength":1,"example":"01HX7K2YV9D3M8N0G6Q5R4S3T2","description":"Workspace identifier."},"required":true,"description":"Workspace identifier.","name":"id","in":"path"},{"schema":{"type":"string","minLength":1,"description":"Optional. Pagination cursor — pass back the `nextCursor` value from a previous response. Omit to fetch the first page."},"required":false,"description":"Optional. Pagination cursor — pass back the `nextCursor` value from a previous response. Omit to fetch the first page.","name":"cursor","in":"query"}],"responses":{"200":{"description":"A list of tags for the workspace.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/PublicApiWorkspaceTagsList"}}}},"400":{"description":"Validation failed.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/PublicApiValidationErrorResponse"}}}},"401":{"description":"Unauthorized.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/PublicApiErrorResponse"}}}},"403":{"description":"Forbidden.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/PublicApiErrorResponse"}}}},"404":{"description":"Workspace not found.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/PublicApiErrorResponse"}}}}}}},"/v1/audits/geo/crawlability-checks":{"get":{"tags":["Audits"],"summary":"List crawlability checks","security":[{"BearerAuth":[]}],"parameters":[{"schema":{"type":"string","minLength":1,"description":"Optional. Pagination cursor — pass back the `nextCursor` value from a previous response. Omit to fetch the first page."},"required":false,"description":"Optional. Pagination cursor — pass back the `nextCursor` value from a previous response. Omit to fetch the first page.","name":"cursor","in":"query"},{"schema":{"type":"string","minLength":1,"example":"01HX7K2YV9D3M8N0G6Q5R4S3T2","description":"Optional. Filter results to a specific workspace the API key has access to. If omitted, results span every workspace the API key can read."},"required":false,"description":"Optional. Filter results to a specific workspace the API key has access to. If omitted, results span every workspace the API key can read.","name":"workspaceId","in":"query"}],"responses":{"200":{"description":"A list of crawlability checks.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/PublicApiCrawlabilityChecksList"}}}},"400":{"description":"Validation failed.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/PublicApiValidationErrorResponse"}}}},"401":{"description":"Unauthorized.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/PublicApiErrorResponse"}}}},"403":{"description":"Forbidden.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/PublicApiErrorResponse"}}}}}},"post":{"tags":["Audits"],"summary":"Create a crawlability check","security":[{"BearerAuth":[]}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/PublicApiCreateCrawlabilityCheckRequest"}}}},"responses":{"201":{"description":"Crawlability check created.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/PublicApiCreateCrawlabilityCheckResponse"}}}},"400":{"description":"Validation failed.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/PublicApiValidationErrorResponse"}}}},"401":{"description":"Unauthorized.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/PublicApiErrorResponse"}}}},"403":{"description":"Forbidden.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/PublicApiErrorResponse"}}}},"429":{"description":"Quota exhausted.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/PublicApiErrorResponse"}}}}}}},"/v1/audits/geo/crawlability-checks/{checkId}":{"get":{"tags":["Audits"],"summary":"Get a crawlability check","security":[{"BearerAuth":[]}],"parameters":[{"schema":{"type":"string","minLength":1,"example":"01HX7K2YV9D3M8N0G6Q5R4S3T2","description":"Crawlability check identifier."},"required":true,"description":"Crawlability check identifier.","name":"checkId","in":"path"}],"responses":{"200":{"description":"The crawlability check.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/PublicApiCrawlabilityCheck"}}}},"400":{"description":"Validation failed.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/PublicApiValidationErrorResponse"}}}},"401":{"description":"Unauthorized.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/PublicApiErrorResponse"}}}},"403":{"description":"Forbidden.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/PublicApiErrorResponse"}}}},"404":{"description":"Crawlability check not found.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/PublicApiErrorResponse"}}}}}}},"/v1/audits/geo/content-checks":{"get":{"tags":["Audits"],"summary":"List content checks","security":[{"BearerAuth":[]}],"parameters":[{"schema":{"type":"string","minLength":1,"description":"Optional. Pagination cursor — pass back the `nextCursor` value from a previous response. Omit to fetch the first page."},"required":false,"description":"Optional. Pagination cursor — pass back the `nextCursor` value from a previous response. Omit to fetch the first page.","name":"cursor","in":"query"},{"schema":{"type":"string","minLength":1,"example":"01HX7K2YV9D3M8N0G6Q5R4S3T2","description":"Optional. Filter results to a specific workspace the API key has access to. If omitted, results span every workspace the API key can read."},"required":false,"description":"Optional. Filter results to a specific workspace the API key has access to. If omitted, results span every workspace the API key can read.","name":"workspaceId","in":"query"}],"responses":{"200":{"description":"A list of content checks.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/PublicApiContentChecksList"}}}},"400":{"description":"Validation failed.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/PublicApiValidationErrorResponse"}}}},"401":{"description":"Unauthorized.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/PublicApiErrorResponse"}}}},"403":{"description":"Forbidden.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/PublicApiErrorResponse"}}}}}},"post":{"tags":["Audits"],"summary":"Create a content check","security":[{"BearerAuth":[]}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/PublicApiCreateContentCheckRequest"}}}},"responses":{"201":{"description":"Content check created.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/PublicApiCreateContentCheckResponse"}}}},"400":{"description":"Validation failed.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/PublicApiValidationErrorResponse"}}}},"401":{"description":"Unauthorized.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/PublicApiErrorResponse"}}}},"403":{"description":"Forbidden.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/PublicApiErrorResponse"}}}},"429":{"description":"Quota exhausted.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/PublicApiErrorResponse"}}}}}}},"/v1/audits/geo/content-checks/{checkId}":{"get":{"tags":["Audits"],"summary":"Get a content check","security":[{"BearerAuth":[]}],"parameters":[{"schema":{"type":"string","minLength":1,"example":"01HX7K2YV9D3M8N0G6Q5R4S3T2","description":"Content check identifier."},"required":true,"description":"Content check identifier.","name":"checkId","in":"path"}],"responses":{"200":{"description":"The content check.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/PublicApiContentCheck"}}}},"400":{"description":"Validation failed.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/PublicApiValidationErrorResponse"}}}},"401":{"description":"Unauthorized.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/PublicApiErrorResponse"}}}},"403":{"description":"Forbidden.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/PublicApiErrorResponse"}}}},"404":{"description":"Content check not found.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/PublicApiErrorResponse"}}}}}}},"/v1/reports/brand":{"get":{"tags":["Brand Reports"],"summary":"List brand reports","security":[{"BearerAuth":[]}],"parameters":[{"schema":{"type":"string","minLength":1,"description":"Optional. Pagination cursor — pass back the `nextCursor` value from a previous response. Omit to fetch the first page."},"required":false,"description":"Optional. Pagination cursor — pass back the `nextCursor` value from a previous response. Omit to fetch the first page.","name":"cursor","in":"query"},{"schema":{"type":"string","minLength":1,"example":"01HX7K2YV9D3M8N0G6Q5R4S3T2","description":"Optional. Filter results to a specific workspace the API key has access to. If omitted, results span every workspace the API key can read."},"required":false,"description":"Optional. Filter results to a specific workspace the API key has access to. If omitted, results span every workspace the API key can read.","name":"workspaceId","in":"query"}],"responses":{"200":{"description":"A list of brand reports.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/PublicApiBrandReportsList"}}}},"400":{"description":"Validation failed.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/PublicApiValidationErrorResponse"}}}},"401":{"description":"Unauthorized.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/PublicApiErrorResponse"}}}},"403":{"description":"Forbidden.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/PublicApiErrorResponse"}}}}}}},"/v1/reports/brand/{reportId}":{"get":{"tags":["Brand Reports"],"summary":"Get a brand report","security":[{"BearerAuth":[]}],"parameters":[{"schema":{"type":"string","minLength":1,"example":"01HX7K2YV9D3M8N0G6Q5R4S3T2","description":"Brand report identifier."},"required":true,"description":"Brand report identifier.","name":"reportId","in":"path"}],"responses":{"200":{"description":"The brand report.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/PublicApiBrandReport"}}}},"400":{"description":"Validation failed.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/PublicApiValidationErrorResponse"}}}},"401":{"description":"Unauthorized.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/PublicApiErrorResponse"}}}},"403":{"description":"Forbidden.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/PublicApiErrorResponse"}}}},"404":{"description":"Report not found.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/PublicApiErrorResponse"}}}}}}},"/v1/reports/brand/{reportId}/stats":{"get":{"tags":["Brand Reports"],"summary":"Get statistics for a brand report","security":[{"BearerAuth":[]}],"parameters":[{"schema":{"type":"string","minLength":1,"example":"01HX7K2YV9D3M8N0G6Q5R4S3T2","description":"Brand report identifier."},"required":true,"description":"Brand report identifier.","name":"reportId","in":"path"},{"schema":{"type":"string","minLength":1,"description":"Start date for the stats window (inclusive).","example":"2025-01-01"},"required":true,"description":"Start date for the stats window (inclusive).","name":"startDate","in":"query"},{"schema":{"type":"string","minLength":1,"description":"End date for the stats window (inclusive).","example":"2025-01-31"},"required":true,"description":"End date for the stats window (inclusive).","name":"endDate","in":"query"},{"schema":{"type":"string","minLength":1,"description":"Country code to filter stats by. Lowercase ISO 3166-1 alpha-2; use `uk` for the United Kingdom.","example":"us"},"required":true,"description":"Country code to filter stats by. Lowercase ISO 3166-1 alpha-2; use `uk` for the United Kingdom.","name":"country","in":"query"},{"schema":{"anyOf":[{"type":"string","enum":["chatgpt","google","perplexity","copilot","google_ai_mode","gemini"],"description":"AI engine identifier.","example":"chatgpt"},{"type":"array","items":{"type":"string","enum":["chatgpt","google","perplexity","copilot","google_ai_mode","gemini"],"description":"AI engine identifier.","example":"chatgpt"}}],"description":"Optional. AI engine(s) to filter by. Repeat the param or pass a single value."},"required":false,"description":"Optional. AI engine(s) to filter by. Repeat the param or pass a single value.","name":"engines","in":"query"},{"schema":{"type":"string","description":"Optional. Filter stats by tag id."},"required":false,"description":"Optional. Filter stats by tag id.","name":"tagId","in":"query"}],"responses":{"200":{"description":"Statistics for the brand report.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/PublicApiBrandReportStats"}}}},"400":{"description":"Validation failed.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/PublicApiValidationErrorResponse"}}}},"401":{"description":"Unauthorized.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/PublicApiErrorResponse"}}}},"403":{"description":"Forbidden.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/PublicApiErrorResponse"}}}},"404":{"description":"Report not found.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/PublicApiErrorResponse"}}}}}}},"/v1/reports/brand/{reportId}/citations":{"get":{"tags":["Brand Reports"],"summary":"List citations for a brand report","security":[{"BearerAuth":[]}],"parameters":[{"schema":{"type":"string","minLength":1,"example":"01HX7K2YV9D3M8N0G6Q5R4S3T2","description":"Brand report identifier."},"required":true,"description":"Brand report identifier.","name":"reportId","in":"path"},{"schema":{"type":"string","minLength":1,"description":"Start date for the citations window (inclusive).","example":"2025-01-01"},"required":true,"description":"Start date for the citations window (inclusive).","name":"startDate","in":"query"},{"schema":{"type":"string","minLength":1,"description":"End date for the citations window (inclusive).","example":"2025-01-31"},"required":true,"description":"End date for the citations window (inclusive).","name":"endDate","in":"query"},{"schema":{"type":"string","minLength":1,"description":"Country code to filter citations by. Lowercase ISO 3166-1 alpha-2; use `uk` for the United Kingdom.","example":"us"},"required":true,"description":"Country code to filter citations by. Lowercase ISO 3166-1 alpha-2; use `uk` for the United Kingdom.","name":"country","in":"query"},{"schema":{"anyOf":[{"type":"string","enum":["chatgpt","google","perplexity","copilot","google_ai_mode","gemini"],"description":"AI engine identifier.","example":"chatgpt"},{"type":"array","items":{"type":"string","enum":["chatgpt","google","perplexity","copilot","google_ai_mode","gemini"],"description":"AI engine identifier.","example":"chatgpt"}}],"description":"Optional. AI engine(s) to filter by. Repeat the param or pass a single value."},"required":false,"description":"Optional. AI engine(s) to filter by. Repeat the param or pass a single value.","name":"engines","in":"query"},{"schema":{"type":"string","description":"Optional. Filter citations by tag id."},"required":false,"description":"Optional. Filter citations by tag id.","name":"tagId","in":"query"},{"schema":{"anyOf":[{"type":"string"},{"type":"array","items":{"type":"string"}}],"description":"Optional. Filter citations to specific domains."},"required":false,"description":"Optional. Filter citations to specific domains.","name":"domains","in":"query"},{"schema":{"type":"string","description":"Optional. Free-text search."},"required":false,"description":"Optional. Free-text search.","name":"search","in":"query"},{"schema":{"type":"integer","description":"Optional. Zero-based offset for pagination."},"required":false,"description":"Optional. Zero-based offset for pagination.","name":"offset","in":"query"},{"schema":{"type":"integer","description":"Optional. Maximum number of items to return."},"required":false,"description":"Optional. Maximum number of items to return.","name":"limit","in":"query"},{"schema":{"type":"string","description":"Optional. Field to sort by."},"required":false,"description":"Optional. Field to sort by.","name":"sortBy","in":"query"},{"schema":{"type":"string","enum":["asc","desc"],"description":"Optional. Sort direction."},"required":false,"description":"Optional. Sort direction.","name":"sortOrder","in":"query"},{"schema":{"type":"boolean","description":"Optional. Filter citations where the brand is mentioned."},"required":false,"description":"Optional. Filter citations where the brand is mentioned.","name":"brandMentioned","in":"query"},{"schema":{"anyOf":[{"type":"string"},{"type":"array","items":{"type":"string"}}],"description":"Optional. Filter by one or more competitor brand names."},"required":false,"description":"Optional. Filter by one or more competitor brand names.","name":"competitors","in":"query"},{"schema":{"anyOf":[{"type":"string","enum":["Social Media","Community/Forum","Brand","Encyclopedia","News/Media","Blogs/Personal Sites","Government/NGO","Education","Video","Competitor","Others","Unclassified"],"description":"Domain classification.","example":"News/Media"},{"type":"array","items":{"type":"string","enum":["Social Media","Community/Forum","Brand","Encyclopedia","News/Media","Blogs/Personal Sites","Government/NGO","Education","Video","Competitor","Others","Unclassified"],"description":"Domain classification.","example":"News/Media"}}],"description":"Optional. Domain category/categories to filter by. Repeat the param or pass a single value."},"required":false,"description":"Optional. Domain category/categories to filter by. Repeat the param or pass a single value.","name":"domainCategories","in":"query"}],"responses":{"200":{"description":"A page of citations for the brand report.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/PublicApiBrandReportCitationsList"}}}},"400":{"description":"Validation failed.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/PublicApiValidationErrorResponse"}}}},"401":{"description":"Unauthorized.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/PublicApiErrorResponse"}}}},"403":{"description":"Forbidden.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/PublicApiErrorResponse"}}}},"404":{"description":"Report not found.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/PublicApiErrorResponse"}}}}}}},"/v1/reports/brand/{reportId}/citations/stats":{"get":{"tags":["Brand Reports"],"summary":"Get citation statistics for a brand report","security":[{"BearerAuth":[]}],"parameters":[{"schema":{"type":"string","minLength":1,"example":"01HX7K2YV9D3M8N0G6Q5R4S3T2","description":"Brand report identifier."},"required":true,"description":"Brand report identifier.","name":"reportId","in":"path"},{"schema":{"type":"string","minLength":1,"description":"Start date for the stats window (inclusive).","example":"2025-01-01"},"required":true,"description":"Start date for the stats window (inclusive).","name":"startDate","in":"query"},{"schema":{"type":"string","minLength":1,"description":"End date for the stats window (inclusive).","example":"2025-01-31"},"required":true,"description":"End date for the stats window (inclusive).","name":"endDate","in":"query"},{"schema":{"type":"string","minLength":1,"description":"Country code to filter by. Lowercase ISO 3166-1 alpha-2; use `uk` for the United Kingdom.","example":"us"},"required":true,"description":"Country code to filter by. Lowercase ISO 3166-1 alpha-2; use `uk` for the United Kingdom.","name":"country","in":"query"},{"schema":{"anyOf":[{"type":"string","enum":["chatgpt","google","perplexity","copilot","google_ai_mode","gemini"],"description":"AI engine identifier.","example":"chatgpt"},{"type":"array","items":{"type":"string","enum":["chatgpt","google","perplexity","copilot","google_ai_mode","gemini"],"description":"AI engine identifier.","example":"chatgpt"}}],"description":"Optional. AI engine(s) to filter by. Repeat the param or pass a single value."},"required":false,"description":"Optional. AI engine(s) to filter by. Repeat the param or pass a single value.","name":"engines","in":"query"},{"schema":{"type":"string","description":"Optional. Filter stats by tag id."},"required":false,"description":"Optional. Filter stats by tag id.","name":"tagId","in":"query"},{"schema":{"type":"integer","description":"Optional. Cap on number of distinct domains aggregated into the response. Positive integer.","example":10},"required":false,"description":"Optional. Cap on number of distinct domains aggregated into the response. Positive integer.","name":"domainLimit","in":"query"}],"responses":{"200":{"description":"Citation statistics for the brand report.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/PublicApiBrandReportCitationStatsResponse"}}}},"400":{"description":"Validation failed.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/PublicApiValidationErrorResponse"}}}},"401":{"description":"Unauthorized.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/PublicApiErrorResponse"}}}},"403":{"description":"Forbidden.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/PublicApiErrorResponse"}}}},"404":{"description":"Report not found.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/PublicApiErrorResponse"}}}}}}},"/v1/reports/brand/{reportId}/citations/prompts":{"get":{"tags":["Brand Reports"],"summary":"List prompts for a cited URL","security":[{"BearerAuth":[]}],"parameters":[{"schema":{"type":"string","minLength":1,"example":"01HX7K2YV9D3M8N0G6Q5R4S3T2","description":"Brand report identifier."},"required":true,"description":"Brand report identifier.","name":"reportId","in":"path"},{"schema":{"type":"string","minLength":1,"description":"Cited URL to fetch prompts for. URL-encoded.","example":"https://example.com/guides/best-flat-feet-running-shoes"},"required":true,"description":"Cited URL to fetch prompts for. URL-encoded.","name":"url","in":"query"},{"schema":{"type":"string","minLength":1,"description":"Start date for the lookup window (inclusive).","example":"2025-01-01"},"required":true,"description":"Start date for the lookup window (inclusive).","name":"startDate","in":"query"},{"schema":{"type":"string","minLength":1,"description":"End date for the lookup window (inclusive).","example":"2025-01-31"},"required":true,"description":"End date for the lookup window (inclusive).","name":"endDate","in":"query"},{"schema":{"type":"string","minLength":1,"description":"Country code to filter by. Lowercase ISO 3166-1 alpha-2; use `uk` for the United Kingdom.","example":"us"},"required":true,"description":"Country code to filter by. Lowercase ISO 3166-1 alpha-2; use `uk` for the United Kingdom.","name":"country","in":"query"},{"schema":{"anyOf":[{"type":"string","enum":["chatgpt","google","perplexity","copilot","google_ai_mode","gemini"],"description":"AI engine identifier.","example":"chatgpt"},{"type":"array","items":{"type":"string","enum":["chatgpt","google","perplexity","copilot","google_ai_mode","gemini"],"description":"AI engine identifier.","example":"chatgpt"}}],"description":"Optional. AI engine(s) to filter by. Repeat the param or pass a single value."},"required":false,"description":"Optional. AI engine(s) to filter by. Repeat the param or pass a single value.","name":"engines","in":"query"},{"schema":{"type":"string","description":"Optional. Filter prompts by tag id."},"required":false,"description":"Optional. Filter prompts by tag id.","name":"tagId","in":"query"}],"responses":{"200":{"description":"A list of prompts that cited the given URL.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/PublicApiBrandReportCitationPromptsList"}}}},"400":{"description":"Validation failed.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/PublicApiValidationErrorResponse"}}}},"401":{"description":"Unauthorized.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/PublicApiErrorResponse"}}}},"403":{"description":"Forbidden.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/PublicApiErrorResponse"}}}},"404":{"description":"Report not found.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/PublicApiErrorResponse"}}}}}}},"/v1/reports/brand/{reportId}/prompts":{"get":{"tags":["Brand Reports"],"summary":"List prompts for a brand report","security":[{"BearerAuth":[]}],"parameters":[{"schema":{"type":"string","minLength":1,"example":"01HX7K2YV9D3M8N0G6Q5R4S3T2","description":"Brand report identifier."},"required":true,"description":"Brand report identifier.","name":"reportId","in":"path"},{"schema":{"type":"string","minLength":1,"description":"Start date for the prompts window (inclusive).","example":"2025-01-01"},"required":true,"description":"Start date for the prompts window (inclusive).","name":"startDate","in":"query"},{"schema":{"type":"string","minLength":1,"description":"End date for the prompts window (inclusive).","example":"2025-01-31"},"required":true,"description":"End date for the prompts window (inclusive).","name":"endDate","in":"query"},{"schema":{"type":"string","minLength":1,"description":"Country code to filter prompts by. Lowercase ISO 3166-1 alpha-2; use `uk` for the United Kingdom.","example":"us"},"required":true,"description":"Country code to filter prompts by. Lowercase ISO 3166-1 alpha-2; use `uk` for the United Kingdom.","name":"country","in":"query"},{"schema":{"anyOf":[{"type":"string","enum":["chatgpt","google","perplexity","copilot","google_ai_mode","gemini"],"description":"AI engine identifier.","example":"chatgpt"},{"type":"array","items":{"type":"string","enum":["chatgpt","google","perplexity","copilot","google_ai_mode","gemini"],"description":"AI engine identifier.","example":"chatgpt"}}],"description":"Optional. AI engine(s) to filter by. Repeat the param or pass a single value."},"required":false,"description":"Optional. AI engine(s) to filter by. Repeat the param or pass a single value.","name":"engines","in":"query"},{"schema":{"type":"string","description":"Optional. Filter prompts by tag id."},"required":false,"description":"Optional. Filter prompts by tag id.","name":"tagId","in":"query"},{"schema":{"type":"string","description":"Optional. Free-text search."},"required":false,"description":"Optional. Free-text search.","name":"search","in":"query"},{"schema":{"type":"integer","description":"Optional. Zero-based offset for pagination."},"required":false,"description":"Optional. Zero-based offset for pagination.","name":"offset","in":"query"},{"schema":{"type":"integer","description":"Optional. Maximum number of items to return."},"required":false,"description":"Optional. Maximum number of items to return.","name":"limit","in":"query"},{"schema":{"type":"string","description":"Optional. Field to sort by."},"required":false,"description":"Optional. Field to sort by.","name":"sortBy","in":"query"},{"schema":{"type":"string","enum":["asc","desc"],"description":"Optional. Sort direction."},"required":false,"description":"Optional. Sort direction.","name":"sortOrder","in":"query"},{"schema":{"type":"boolean","description":"Optional. Filter prompts where the brand is mentioned."},"required":false,"description":"Optional. Filter prompts where the brand is mentioned.","name":"brandMentioned","in":"query"},{"schema":{"anyOf":[{"type":"string"},{"type":"array","items":{"type":"string"}}],"description":"Optional. Filter by one or more competitor brand names."},"required":false,"description":"Optional. Filter by one or more competitor brand names.","name":"competitors","in":"query"},{"schema":{"anyOf":[{"type":"string","enum":["Social Media","Community/Forum","Brand","Encyclopedia","News/Media","Blogs/Personal Sites","Government/NGO","Education","Video","Competitor","Others","Unclassified"],"description":"Domain classification.","example":"News/Media"},{"type":"array","items":{"type":"string","enum":["Social Media","Community/Forum","Brand","Encyclopedia","News/Media","Blogs/Personal Sites","Government/NGO","Education","Video","Competitor","Others","Unclassified"],"description":"Domain classification.","example":"News/Media"}}],"description":"Optional. Domain category/categories to filter by. Repeat the param or pass a single value."},"required":false,"description":"Optional. Domain category/categories to filter by. Repeat the param or pass a single value.","name":"domainCategories","in":"query"},{"schema":{"anyOf":[{"type":"string"},{"type":"array","items":{"type":"string"}}],"description":"Optional. Filter prompts to specific domains."},"required":false,"description":"Optional. Filter prompts to specific domains.","name":"domains","in":"query"}],"responses":{"200":{"description":"A page of prompts for the brand report.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/PublicApiBrandReportPromptsList"}}}},"400":{"description":"Validation failed.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/PublicApiValidationErrorResponse"}}}},"401":{"description":"Unauthorized.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/PublicApiErrorResponse"}}}},"403":{"description":"Forbidden.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/PublicApiErrorResponse"}}}},"404":{"description":"Report not found.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/PublicApiErrorResponse"}}}}}}},"/v1/reports/brand/{reportId}/prompts/{promptId}":{"get":{"tags":["Brand Reports"],"summary":"Get prompt details from a brand report.","security":[{"BearerAuth":[]}],"parameters":[{"schema":{"type":"string","minLength":1,"example":"01HX7K2YV9D3M8N0G6Q5R4S3T2","description":"Brand report identifier."},"required":true,"description":"Brand report identifier.","name":"reportId","in":"path"},{"schema":{"type":"string","minLength":1,"example":"01HX7K2YV9D3M8N0G6Q5R4S3T2","description":"Prompt identifier within the brand report."},"required":true,"description":"Prompt identifier within the brand report.","name":"promptId","in":"path"},{"schema":{"type":"string","minLength":1,"description":"Start date for the lookup window (inclusive). Accepts `YYYY-MM-DD` or a full ISO timestamp; only the date portion is used and the window is anchored at `00:00:00.000Z`.","example":"2025-01-01"},"required":true,"description":"Start date for the lookup window (inclusive). Accepts `YYYY-MM-DD` or a full ISO timestamp; only the date portion is used and the window is anchored at `00:00:00.000Z`.","name":"startDate","in":"query"},{"schema":{"type":"string","minLength":1,"description":"End date for the lookup window (inclusive). Accepts `YYYY-MM-DD` or a full ISO timestamp; only the date portion is used and the window is anchored at `23:59:59.999Z`.","example":"2025-01-31"},"required":true,"description":"End date for the lookup window (inclusive). Accepts `YYYY-MM-DD` or a full ISO timestamp; only the date portion is used and the window is anchored at `23:59:59.999Z`.","name":"endDate","in":"query"},{"schema":{"type":"string","minLength":1,"description":"Country code to filter by. Lowercase ISO 3166-1 alpha-2; use `uk` for the United Kingdom.","example":"us"},"required":true,"description":"Country code to filter by. Lowercase ISO 3166-1 alpha-2; use `uk` for the United Kingdom.","name":"country","in":"query"}],"responses":{"200":{"description":"Details for the prompt within the brand report.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/PublicApiBrandReportPromptDetail"}}}},"400":{"description":"Validation failed.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/PublicApiValidationErrorResponse"}}}},"401":{"description":"Unauthorized.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/PublicApiErrorResponse"}}}},"403":{"description":"Forbidden.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/PublicApiErrorResponse"}}}},"404":{"description":"Report or prompt not found.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/PublicApiErrorResponse"}}}}}}},"/v1/reports/brand/{reportId}/prompts/{promptId}/ai-responses":{"get":{"tags":["Brand Reports"],"summary":"List AI responses for a prompt in a brand report.","security":[{"BearerAuth":[]}],"parameters":[{"schema":{"type":"string","minLength":1,"example":"01HX7K2YV9D3M8N0G6Q5R4S3T2","description":"Brand report identifier."},"required":true,"description":"Brand report identifier.","name":"reportId","in":"path"},{"schema":{"type":"string","minLength":1,"example":"01HX7K2YV9D3M8N0G6Q5R4S3T2","description":"Prompt identifier within the brand report."},"required":true,"description":"Prompt identifier within the brand report.","name":"promptId","in":"path"},{"schema":{"type":"string","minLength":1,"description":"Start date for the lookup window (inclusive). Accepts `YYYY-MM-DD` or a full ISO timestamp; only the date portion is used and the window is anchored at `00:00:00.000Z`.","example":"2025-01-01"},"required":true,"description":"Start date for the lookup window (inclusive). Accepts `YYYY-MM-DD` or a full ISO timestamp; only the date portion is used and the window is anchored at `00:00:00.000Z`.","name":"startDate","in":"query"},{"schema":{"type":"string","minLength":1,"description":"End date for the lookup window (inclusive). Accepts `YYYY-MM-DD` or a full ISO timestamp; only the date portion is used and the window is anchored at `23:59:59.999Z`.","example":"2025-01-31"},"required":true,"description":"End date for the lookup window (inclusive). Accepts `YYYY-MM-DD` or a full ISO timestamp; only the date portion is used and the window is anchored at `23:59:59.999Z`.","name":"endDate","in":"query"},{"schema":{"type":"string","minLength":1,"description":"Country code to filter by. Lowercase ISO 3166-1 alpha-2; use `uk` for the United Kingdom.","example":"us"},"required":true,"description":"Country code to filter by. Lowercase ISO 3166-1 alpha-2; use `uk` for the United Kingdom.","name":"country","in":"query"},{"schema":{"type":"string","minLength":1,"description":"Optional. Pagination cursor — pass back the `nextCursor` value from a previous response. Omit to fetch the first page."},"required":false,"description":"Optional. Pagination cursor — pass back the `nextCursor` value from a previous response. Omit to fetch the first page.","name":"cursor","in":"query"}],"responses":{"200":{"description":"AI responses (jobs) collected for the prompt within the window.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/PublicApiBrandReportPromptAiResponsesList"}}}},"400":{"description":"Validation failed.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/PublicApiValidationErrorResponse"}}}},"401":{"description":"Unauthorized.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/PublicApiErrorResponse"}}}},"403":{"description":"Forbidden.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/PublicApiErrorResponse"}}}},"404":{"description":"Report or prompt not found.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/PublicApiErrorResponse"}}}}}}},"/v1/reports/brand/{reportId}/recommendations":{"get":{"tags":["Brand Reports"],"summary":"List recommendations for a brand report","security":[{"BearerAuth":[]}],"parameters":[{"schema":{"type":"string","minLength":1,"example":"01HX7K2YV9D3M8N0G6Q5R4S3T2","description":"Brand report identifier."},"required":true,"description":"Brand report identifier.","name":"reportId","in":"path"},{"schema":{"type":"string","minLength":1,"description":"Country code to filter recommendations by. Lowercase ISO 3166-1 alpha-2; use `uk` for the United Kingdom.","example":"us"},"required":true,"description":"Country code to filter recommendations by. Lowercase ISO 3166-1 alpha-2; use `uk` for the United Kingdom.","name":"country","in":"query"},{"schema":{"type":"string","enum":["chatgpt","google","perplexity","copilot","google_ai_mode","gemini"],"description":"Optional. Filter results to a single AI engine.","example":"chatgpt"},"required":false,"description":"Optional. Filter results to a single AI engine.","name":"engine","in":"query"},{"schema":{"type":"string","minLength":1,"description":"Optional. Pagination cursor — pass back the `nextCursor` value from a previous response. Omit to fetch the first page."},"required":false,"description":"Optional. Pagination cursor — pass back the `nextCursor` value from a previous response. Omit to fetch the first page.","name":"cursor","in":"query"}],"responses":{"200":{"description":"A list of recommendations for the brand report.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/PublicApiBrandReportRecommendationsList"}}}},"400":{"description":"Validation failed.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/PublicApiValidationErrorResponse"}}}},"401":{"description":"Unauthorized.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/PublicApiErrorResponse"}}}},"403":{"description":"Forbidden.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/PublicApiErrorResponse"}}}},"404":{"description":"Report not found.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/PublicApiErrorResponse"}}}}}}},"/v1/accounts/info":{"get":{"tags":["Accounts"],"summary":"Get account information","description":"Returns the authenticated team's subscription plan, end date, and current period usage/limits for prompts, GEO audits, and public API requests.","security":[{"BearerAuth":[]}],"responses":{"200":{"description":"Account information for the authenticated team.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/AccountInfoResponse"}}}},"401":{"description":"Unauthorized.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/PublicApiErrorResponse"}}}},"403":{"description":"Forbidden.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/PublicApiErrorResponse"}}}},"404":{"description":"Team not found.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/PublicApiErrorResponse"}}}},"429":{"description":"Quota exhausted.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/PublicApiErrorResponse"}}}}}}}}}