Visibility
Brand Analysis Overview
Get detailed brand analysis including overall sentiment, competitors, aggregated metrics, and detailed prompt analysis across various AI models.
GET
/api/v1/brand-analysis/:siteIdBrand Analysis Overview
cURL
curl --request GET \ --url 'https://app.indexly.ai/api/v1/brand-analysis/SITE_ID' \ --header 'X-API-Key: YOUR_API_KEY'
Response
{
"id": "69b2896f37fec75a97d15863",
"siteId": "69b15759684ecce74b9f506b",
"website": "indexly.ai",
"companyName": "Indexly AI",
"description": "Indexly AI is an SEO and search visibility platform.",
"brand": {
"id": "69b2896f37fec75a97d15864",
"name": "indexly.ai",
"website": "https://indexly.ai",
"isUserBrand": true
},
"competitors": [
"competitorA.com",
"competitorB.com"
],
"totalPrompts": 10,
"presentCount": 5,
"averageRank": 2.5,
"totalVolume": 1200,
"overallSentiment": {
"score": 85,
"summary": "Indexly shows strong technical capabilities and reliable indexing performance, though some users desire more integrations.",
"strengths": [
"Fast and reliable search indexation",
"Comprehensive dashboard analytics",
"Strong technical foundation"
],
"weaknesses": [
"Limited third-party integrations currently",
"Pricing can be high for large enterprise sites"
]
},
"analyzedAt": "2026-03-12T09:37:51.841Z",
"openaiPrompts": [
{
"prompt": "Best SEO indexing tools 2026",
"category": "Solution Research",
"present": true,
"rank": 2,
"volume": 850,
"details": {
"competitors": ["competitorA.com"],
"fullResponse": "Indexly AI is considered among the top indexing tools...",
"sentiment": "positive",
"marketPosition": "Leader"
}
}
],
"claudePrompts": [],
"googlePrompts": [],
"perplexityPrompts": [],
"grokPrompts": []
}Authorizations
X-API-Keystringheaderrequired
API key for authentication. Get yours from the Indexly dashboard under Settings → API Access
Path parameters
siteIdstringrequired
Site ID (must belong to your organization). Get it from your Indexly dashboard.
Response
200 application/jsonDefault Response
overallSentimentobjectrequired— Contains score, summary, strengths, and weaknesses of the brand perception.
competitorsarrayrequired— List of top competitor names.
totalPromptsintegerrequired— Total number of evaluated prompts in the analysis.
presentCountintegerrequired— Number of prompts where the brand was present or recommended.
averageRanknumberrequired— The average ranking of the user brand in prompt responses.
totalVolumeintegerrequired— Aggregate search volume of all analyzed prompts.
openaiPromptsarrayrequired— List of PromptAnalysis objects from the OpenAI model.
googlePromptsarrayrequired— List of PromptAnalysis objects from Google (Gemini).
claudePromptsarrayrequired— List of PromptAnalysis objects from Claude (Anthropic).
perplexityPromptsarrayrequired— List of PromptAnalysis objects from Perplexity.
grokPromptsarrayrequired— List of PromptAnalysis objects from Grok.