Brands - OpenSight

List Brands

Response

Brand[]

Array of brand objects

Show Brand properties

string

required

Unique brand identifier

string

required

Owner’s user ID

string

required

Brand name

string

required

Brand website URL

string | null

Brand industry (SaaS, E-commerce, Finance, Healthcare, Agency, Other)

boolean

required

Whether the brand is active

string

required

ISO 8601 timestamp

string

required

ISO 8601 timestamp

Example Request

curl -X GET "https://api.opensight.ai/api/brands" \
  -H "Authorization: Bearer YOUR_API_KEY"

Example Response

{
  "brands": [
    {
      "id": "brand_123",
      "user_id": "user_456",
      "name": "Acme Inc",
      "website_url": "https://acme.com",
      "industry": "SaaS",
      "is_active": true,
      "created_at": "2024-01-15T10:00:00Z",
      "updated_at": "2024-01-15T10:00:00Z"
    }
  ]
}

Create Brand

Request Body

string

required

Brand name (1-255 characters)

string

required

Valid brand website URL

string

Brand industry (SaaS, E-commerce, Finance, Healthcare, Agency, Other)

Response

Brand

The created brand object

Example Request

curl -X POST "https://api.opensight.ai/api/brands" \
  -H "Authorization: Bearer YOUR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "name": "Acme Inc",
    "website_url": "https://acme.com",
    "industry": "SaaS"
  }'

Example Response

{
  "brand": {
    "id": "brand_123",
    "user_id": "user_456",
    "name": "Acme Inc",
    "website_url": "https://acme.com",
    "industry": "SaaS",
    "is_active": true,
    "created_at": "2024-01-15T10:00:00Z",
    "updated_at": "2024-01-15T10:00:00Z"
  }
}

Errors

403 Forbidden - Brand limit reached for your plan
400 Bad Request - Invalid input data

Get Brand

Path Parameters

string

required

Brand ID

Response

Brand

The brand object

Example Request

curl -X GET "https://api.opensight.ai/api/brands/brand_123" \
  -H "Authorization: Bearer YOUR_API_KEY"

Errors

404 Not Found - Brand not found or user doesn’t own it

Update Brand

Path Parameters

string

required

Brand ID

Request Body

string

Brand name (1-255 characters)

string

Valid website URL

string

Brand industry

boolean

Whether to pin the brand in the UI

Response

Brand

The updated brand object

Example Request

curl -X PATCH "https://api.opensight.ai/api/brands/brand_123" \
  -H "Authorization: Bearer YOUR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "name": "Acme Corporation",
    "pinned": true
  }'

Errors

404 Not Found - Brand not found or user doesn’t own it

Delete Brand

Path Parameters

string

required

Brand ID

Response

boolean

Returns true if successful

Example Request

curl -X DELETE "https://api.opensight.ai/api/brands/brand_123" \
  -H "Authorization: Bearer YOUR_API_KEY"

Errors

404 Not Found - Brand not found or user doesn’t own it

Get Brand Dashboard

Path Parameters

string

required

Brand ID

Response

number

Overall visibility score (0-100)

object

Scores per engine

Show Engine scores properties

number | null

ChatGPT visibility score

number | null

Perplexity visibility score

number | null

Google AI Overviews visibility score

object

Sentiment distribution

Show Sentiment properties

number

Percentage of positive mentions

number

Percentage of neutral mentions

number

Percentage of negative mentions

number

Total number of brand mentions

number

Total number of active prompts

Change[]

Array of recent changes

Show Change properties

string

Change ID

string

Change type: visibility_up, visibility_down, new_mention, sentiment_shift

string

Human-readable description

string | null

Engine where change occurred

number | null

Numeric change value

string

ISO 8601 timestamp

Example Request

curl -X GET "https://api.opensight.ai/api/brands/brand_123/dashboard" \
  -H "Authorization: Bearer YOUR_API_KEY"

Example Response

{
  "overall_score": 72,
  "engine_scores": {
    "chatgpt": 75,
    "perplexity": 68,
    "google_aio": 73
  },
  "sentiment": {
    "positive": 65,
    "neutral": 30,
    "negative": 5
  },
  "total_mentions": 45,
  "total_prompts": 25,
  "recent_changes": [
    {
      "id": "change_123",
      "type": "visibility_up",
      "description": "Visibility increased by 5 points on ChatGPT",
      "engine": "chatgpt",
      "change_value": 5,
      "created_at": "2024-01-15T10:00:00Z"
    }
  ]
}

Errors

404 Not Found - Brand not found or user doesn’t own it

Get Brand Trends

Path Parameters

string

required

Brand ID

Query Parameters

string

Time range: 7d, 14d, 30d, or 90d (default: 30d)

Response

TrendDataPoint[]

Array of trend data points

Show TrendDataPoint properties

string

ISO 8601 date

number

Overall visibility score

number | null

ChatGPT score

number | null

Perplexity score

number | null

Google AI Overviews score

Example Request

curl -X GET "https://api.opensight.ai/api/brands/brand_123/trends?range=30d" \
  -H "Authorization: Bearer YOUR_API_KEY"

Example Response

{
  "trends": [
    {
      "date": "2024-01-15",
      "overall": 72,
      "chatgpt": 75,
      "perplexity": 68,
      "google_aio": 73
    },
    {
      "date": "2024-01-16",
      "overall": 74,
      "chatgpt": 77,
      "perplexity": 70,
      "google_aio": 75
    }
  ]
}

Errors

404 Not Found - Brand not found or user doesn’t own it

​List Brands

​Response

​Example Request

​Example Response

​Create Brand

​Request Body

​Response

​Example Request

​Example Response

​Errors

​Get Brand

​Path Parameters

​Response

​Example Request

​Errors

​Update Brand

​Path Parameters

​Request Body

​Response

​Example Request

​Errors

​Delete Brand

​Path Parameters

​Response

​Example Request

​Errors

​Get Brand Dashboard

​Path Parameters

​Response

​Example Request

​Example Response

​Errors

​Get Brand Trends

​Path Parameters

​Query Parameters

​Response

​Example Request

​Example Response

​Errors

List Brands

Response

Example Request

Example Response

Create Brand

Request Body

Response

Example Request

Example Response

Errors

Get Brand

Path Parameters

Response

Example Request

Errors

Update Brand

Path Parameters

Request Body

Response

Example Request

Errors

Delete Brand

Path Parameters

Response

Example Request

Errors

Get Brand Dashboard

Path Parameters

Response

Example Request

Example Response

Errors

Get Brand Trends

Path Parameters

Query Parameters

Response

Example Request

Example Response

Errors