List Competitors
Path Parameters
Response
Array of competitor objectsShow Competitor properties
Unique competitor identifier
Example Request
curl -X GET "https://api.opensight.ai/api/brands/brand_123/competitors" \
-H "Authorization: Bearer YOUR_API_KEY"
Example Response
{
"competitors": [
{
"id": "comp_123",
"brand_id": "brand_123",
"name": "Competitor Inc",
"website_url": "https://competitor.com",
"created_at": "2024-01-15T10:00:00Z"
}
]
}
Errors
- 404 Not Found - Brand not found or user doesn’t own it
Add Competitor
Path Parameters
Request Body
Competitor name (1-255 characters)
Valid competitor website URL
Response
The created competitor object
Example Request
curl -X POST "https://api.opensight.ai/api/brands/brand_123/competitors" \
-H "Authorization: Bearer YOUR_API_KEY" \
-H "Content-Type: application/json" \
-d '{
"name": "Competitor Inc",
"website_url": "https://competitor.com"
}'
Example Response
{
"competitor": {
"id": "comp_123",
"brand_id": "brand_123",
"name": "Competitor Inc",
"website_url": "https://competitor.com",
"created_at": "2024-01-15T10:00:00Z"
}
}
Errors
- 403 Forbidden - Competitor limit reached for your plan
- 404 Not Found - Brand not found or user doesn’t own it
- 409 Conflict - Competitor already exists for this brand
- 400 Bad Request - Invalid input data
Plan Limits
- Free: 2 competitors per brand
- Starter: 5 competitors per brand
- Growth: 5 competitors per brand
Remove Competitor
Path Parameters
Response
Returns true if successful
Example Request
curl -X DELETE "https://api.opensight.ai/api/brands/brand_123/competitors/comp_123" \
-H "Authorization: Bearer YOUR_API_KEY"
Example Response
Errors
- 404 Not Found - Brand or competitor not found, or user doesn’t own the brand
Get Competitor Comparison
Path Parameters
Response
Share of voice percentages across all tracked brandsShow Share of voice properties
Percentage of total mentions (0-100)
Prompts where competitors are mentioned but your brand is not
Array of competitor names mentioned
Rankings per prompt showing how brands compareShow Leaderboard properties
Example Request
curl -X GET "https://api.opensight.ai/api/brands/brand_123/competitors/comparison" \
-H "Authorization: Bearer YOUR_API_KEY"
Example Response
{
"share_of_voice": [
{
"brand_name": "Acme Inc",
"percentage": 45.5
},
{
"brand_name": "Competitor Inc",
"percentage": 35.2
},
{
"brand_name": "Other Corp",
"percentage": 19.3
}
],
"gaps": [
{
"prompt": "Best project management software for teams",
"competitors_present": ["Competitor Inc", "Other Corp"]
}
],
"leaderboard": [
{
"prompt": "Top CRM software for small businesses",
"rankings": [
{
"name": "Acme Inc",
"score": 85
},
{
"name": "Competitor Inc",
"score": 72
}
]
}
]
}
Errors
- 404 Not Found - Brand not found or user doesn’t own it