Skip to main content

Documentation Index

Fetch the complete documentation index at: https://docs.get-spotlight.com/llms.txt

Use this file to discover all available pages before exploring further.

​
Get your API key

  1. Open the Spotlight app and go to Settings → API.
  2. Copy your API key.
  3. 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/"
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.