Skip to main content
GET
/
v1
/
runs
/
{runId}
Get run results
curl --request GET \
  --url https://api.example.com/v1/runs/{runId}
{
  "run": {},
  "data": [
    {
      "prompt": {},
      "topic": {}
    }
  ]
}

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.

Returns one record per prompt/LLM combination: presence, sentiment, rank, mentioned brands, and optionally the full LLM response text.

Path parameters

runId
string
required
Run UUID. Obtain from List runs.

Query parameters

include_answer
boolean
default:"false"
Set to true to include the raw LLM response text in each result. Significantly increases response size.
limit
integer
default:"50"
Items per page. Maximum 500.
page
integer
default:"1"
Page number (1-based).

Request

curl -s \
  -H "x-spotlight-api-key: YOUR_API_KEY" \
  "https://app.get-spotlight.com/api/v1/runs/RUN_ID?include_answer=false&limit=50&page=1"

Response

run
object
Basic run metadata.
data
Result[]
Per-prompt analysis results.
{
  "run": { "id": "run-uuid-123", "brandId": "brand-uuid-123", "startedAt": "2025-02-01T10:00:00Z" },
  "data": [
    {
      "id": "result-uuid-1",
      "runId": "run-uuid-123",
      "prompt": { "text": "What do customers say about pricing?", "journeyStage": "consideration" },
      "topic": { "name": "Pricing" },
      "llm": "chatgpt",
      "isPresent": true,
      "rank": 1,
      "sentiment": "positive",
      "mentionedBrands": ["competitor-x"]
    }
  ],
  "paging": { "page": 1, "limit": 50, "total": 200, "nextPage": 2 },
  "includeAnswer": false
}