Quickstart

Get your API key

Open the Spotlight app and go to Settings → API.
Copy your API key.
Note your API Base URL — it looks like https://app.get-spotlight.com/api.

Verify connectivity

Call the root discovery endpoint to confirm your key works and see what’s available:

curl -s \
  -H "x-spotlight-api-key: YOUR_API_KEY" \
  "https://app.get-spotlight.com/api/"

import requests

BASE_URL = "https://app.get-spotlight.com/api"
HEADERS  = {"x-spotlight-api-key": "YOUR_API_KEY"}

r = requests.get(f"{BASE_URL}/", headers=HEADERS)
print(r.json())

const BASE_URL = "https://app.get-spotlight.com/api";
const HEADERS  = { "x-spotlight-api-key": "YOUR_API_KEY" };

const r = await fetch(`${BASE_URL}/`, { headers: HEADERS });
console.log(await r.json());

Response:

{
  "message": "Spotlight Data API",
  "version": "v1",
  "organizationId": "00000000-0000-0000-0000-000000000000",
  "endpoints": [
    { "method": "GET",    "path": "/v1/brands" },
    { "method": "GET",    "path": "/v1/brands/{brandId}/runs" },
    { "method": "GET",    "path": "/v1/runs/{runId}" }
  ]
}

Fetch your brands

curl -s \
  -H "x-spotlight-api-key: YOUR_API_KEY" \
  "https://app.get-spotlight.com/api/v1/brands"

Save the id field from the brand you want to work with — you’ll use it as {brandId} in most other endpoints.

Pull the latest analysis results

curl -s \
  -H "x-spotlight-api-key: YOUR_API_KEY" \
  "https://app.get-spotlight.com/api/v1/brands/BRAND_ID/last/results"

Next steps

Runs

Browse the full history of analysis runs.

Content suggestions

Sync AI-generated content ideas into your backlog.

Sources

See which URLs are driving brand perception.

Perception

Explore scored perception properties.

Get Started

API Reference

Get your API key

Verify connectivity

Fetch your brands

Pull the latest analysis results

Next steps

Runs

Content suggestions

Sources

Perception

​Get your API key

​Verify connectivity

​Fetch your brands

​Pull the latest analysis results

​Next steps

Runs

Content suggestions

Sources

Perception

Get your API key

Verify connectivity

Fetch your brands

Pull the latest analysis results

Next steps