List runs

GET

brands

{brandId}

runs

List runs

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

import requests

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

response = requests.get(url)

print(response.text)

const options = {method: 'GET'};

fetch('https://api.example.com/v1/brands/{brandId}/runs', 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/brands/{brandId}/runs",
  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/brands/{brandId}/runs"

	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/brands/{brandId}/runs")
  .asString();

require 'uri'
require 'net/http'

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

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

{
  "data": [
    {
      "id": "<string>",
      "startedAt": {},
      "metrics": {}
    }
  ],
  "paging": {}
}

An analysis run is a complete processing pass for a brand: collecting LLM responses, scoring presence and sentiment, and computing summary metrics. Use this endpoint to build a run history picker, or to check the latest aggregate stats before diving into per-prompt results.

Path parameters

brandId

string

required

The brand UUID. Obtain it from List brands.

Query parameters

limit

integer

default:"10"

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/brands/BRAND_ID/runs?limit=10&page=1"

import requests

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

const r = await fetch(
  "https://app.get-spotlight.com/api/v1/brands/BRAND_ID/runs?limit=10&page=1",
  { headers: { "x-spotlight-api-key": "YOUR_API_KEY" } }
);
const json = await r.json();

Response

data

Run[]

Array of run objects.

Show Run object

string

Run UUID — use as {runId} in other endpoints.

startedAt

string (ISO 8601)

When the run began.

metrics

object

Aggregate statistics for the run.

paging

Paging

See Pagination.

{
  "data": [
    {
      "id": "run-uuid-123",
      "startedAt": "2025-02-01T10:00:00Z",
      "metrics": {
        "present": 120,
        "positive": 80,
        "negative": 20,
        "neutral": 20,
        "responsesWithBrands": 100,
        "totalResponses": 150,
        "completedResponses": 150,
        "averageRank": 1.8,
        "topics": null,
        "calculatedAt": "2025-02-01T10:30:00Z"
      }
    }
  ],
  "paging": { "page": 1, "limit": 10, "total": 3, "nextPage": null }
}

If a completed run has not had its metrics calculated yet, the API triggers an automatic refresh and returns updated metrics. You always receive accurate numbers.

Get run statsReturn aggregate statistics for a specific run.

List runs

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

import requests

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

response = requests.get(url)

print(response.text)

const options = {method: 'GET'};

fetch('https://api.example.com/v1/brands/{brandId}/runs', 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/brands/{brandId}/runs",
  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/brands/{brandId}/runs"

	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/brands/{brandId}/runs")
  .asString();

require 'uri'
require 'net/http'

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

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

{
  "data": [
    {
      "id": "<string>",
      "startedAt": {},
      "metrics": {}
    }
  ],
  "paging": {}
}

Get Started

API Reference

Path parameters

Query parameters

Request

Response

​Path parameters

​Query parameters

​Request

​Response

Path parameters

Query parameters

Request

Response