# Competitor analysis

Get list of brands (including your brand and competitors) with visibility, mentions, and position for the given site.

## API Endpoint

GET `/api/v1/brand-analysis/:siteId/brands`

### Example cURL Request

```bash
curl --request GET \
  --url 'https://app.indexly.ai/api/v1/brand-analysis/SITE_ID/brands' \
  --header 'X-API-Key: YOUR_API_KEY'
```

### Response Structure

```json
{
  "brands": [
    {
      "name": "Your Brand",
      "website": "https://example.com",
      "isUser": true,
      "visibility": 42,
      "mentions": 120,
      "position": 2.3
    },
    {
      "name": "Competitor A",
      "website": "https://competitor.com",
      "isUser": false,
      "visibility": 28,
      "mentions": 80,
      "position": 3.1
    }
  ]
}
```

## Authorizations

- **X-API-Key**: `string` (header required) - API key for authentication. Get yours from the Indexly dashboard under Settings → API Access.

## Path parameters

- **siteId**: `string` (required) - Site ID (must belong to your organization). Get it from your Indexly dashboard.

## Response

- **200**: `application/json` - Default Response containing an array of brand objects with name, website, isUser, visibility, mentions, position.