Get run results

GET

runs

{runId}

Get run results

curl --request GET \
  --url https://api.example.com/v1/runs/{runId}

import requests

url = "https://api.example.com/v1/runs/{runId}"

response = requests.get(url)

print(response.text)

const options = {method: 'GET'};

fetch('https://api.example.com/v1/runs/{runId}', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://api.example.com/v1/runs/{runId}",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "GET",
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"net/http"
	"io"
)

func main() {

	url := "https://api.example.com/v1/runs/{runId}"

	req, _ := http.NewRequest("GET", url, nil)

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

HttpResponse<String> response = Unirest.get("https://api.example.com/v1/runs/{runId}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://api.example.com/v1/runs/{runId}")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Get.new(url)

response = http.request(request)
puts response.read_body

{
  "run": {},
  "data": [
    {
      "prompt": {},
      "topic": {}
    }
  ]
}

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"

import requests

r = requests.get(
    "https://app.get-spotlight.com/api/v1/runs/RUN_ID",
    headers={"x-spotlight-api-key": "YOUR_API_KEY"},
    params={"include_answer": "false", "limit": 50, "page": 1},
)
print(r.json())

const url = new URL("https://app.get-spotlight.com/api/v1/runs/RUN_ID");
url.searchParams.set("include_answer", "false");
url.searchParams.set("limit", "50");

const r = await fetch(url, {
  headers: { "x-spotlight-api-key": "YOUR_API_KEY" },
});
const json = await r.json();

Response

run

object

Basic run metadata.

Show Run

data

Result[]

Per-prompt analysis results.

Show Result object

prompt

object

Show Prompt

topic

object

Show Topic

{
  "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
}

Get latest resultsReturn per-prompt results for the most recent run of a brand.

Get run results

curl --request GET \
  --url https://api.example.com/v1/runs/{runId}

import requests

url = "https://api.example.com/v1/runs/{runId}"

response = requests.get(url)

print(response.text)

const options = {method: 'GET'};

fetch('https://api.example.com/v1/runs/{runId}', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://api.example.com/v1/runs/{runId}",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "GET",
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"net/http"
	"io"
)

func main() {

	url := "https://api.example.com/v1/runs/{runId}"

	req, _ := http.NewRequest("GET", url, nil)

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

HttpResponse<String> response = Unirest.get("https://api.example.com/v1/runs/{runId}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://api.example.com/v1/runs/{runId}")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Get.new(url)

response = http.request(request)
puts response.read_body

{
  "run": {},
  "data": [
    {
      "prompt": {},
      "topic": {}
    }
  ]
}

Get Started

API Reference

Path parameters

Query parameters

Request

Response

​Path parameters

​Query parameters

​Request

​Response

Path parameters

Query parameters

Request

Response