Competitors

List Competitors

Path Parameters

string

required

Brand ID

Response

Competitor[]

Array of competitor objects

Show Competitor properties

string

required

Unique competitor identifier

string

required

Parent brand ID

string

required

Competitor name

string

required

Competitor website URL

string

required

ISO 8601 timestamp

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

string

required

Brand ID

Request Body

string

required

Competitor name (1-255 characters)

string

required

Valid competitor website URL

Response

Competitor

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

string

required

Brand ID

string

required

Competitor ID

Response

boolean

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

{
  "success": true
}

Errors

404 Not Found - Brand or competitor not found, or user doesn’t own the brand

Get Competitor Comparison

Path Parameters

string

required

Brand ID

Response

Share of voice percentages across all tracked brands

Show Share of voice properties

string

Brand or competitor name

number

Percentage of total mentions (0-100)

object[]

Prompts where competitors are mentioned but your brand is not

Show Gap properties

string

The prompt text

string[]

Array of competitor names mentioned

object[]

Rankings per prompt showing how brands compare

Show Leaderboard properties

string

The prompt text

object[]

Array of brand rankings

Show Ranking properties

string

Brand or competitor name

number

Visibility score (0-100)

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

Getting Started

Endpoints

List Competitors

Path Parameters

Response

Example Request

Example Response

Errors

Add Competitor

Path Parameters

Request Body

Response

Example Request

Example Response

Errors

Plan Limits

Remove Competitor

Path Parameters

Response

Example Request

Example Response

Errors

Get Competitor Comparison

Path Parameters

Response

Example Request

Example Response

Errors

​List Competitors

​Path Parameters

​Response

​Example Request

​Example Response

​Errors

​Add Competitor

​Path Parameters

​Request Body

​Response

​Example Request

​Example Response

​Errors

​Plan Limits

​Remove Competitor

​Path Parameters

​Response

​Example Request

​Example Response

​Errors

​Get Competitor Comparison

​Path Parameters

​Response

​Example Request

​Example Response

​Errors

List Competitors

Path Parameters

Response

Example Request

Example Response

Errors

Add Competitor

Path Parameters

Request Body

Response

Example Request

Example Response

Errors

Plan Limits

Remove Competitor

Path Parameters

Response

Example Request

Example Response

Errors

Get Competitor Comparison

Path Parameters

Response

Example Request

Example Response

Errors