Retrieve Visibility Overview
curl --request GET \
--url https://api.lightsage.com/v2/visibility/overview \
--header 'X-Lightsage-Api-Key: <api-key>'import requests
url = "https://api.lightsage.com/v2/visibility/overview"
headers = {"X-Lightsage-Api-Key": "<api-key>"}
response = requests.get(url, headers=headers)
print(response.text)const options = {method: 'GET', headers: {'X-Lightsage-Api-Key': '<api-key>'}};
fetch('https://api.lightsage.com/v2/visibility/overview', 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.lightsage.com/v2/visibility/overview",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "GET",
CURLOPT_HTTPHEADER => [
"X-Lightsage-Api-Key: <api-key>"
],
]);
$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.lightsage.com/v2/visibility/overview"
req, _ := http.NewRequest("GET", url, nil)
req.Header.Add("X-Lightsage-Api-Key", "<api-key>")
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.lightsage.com/v2/visibility/overview")
.header("X-Lightsage-Api-Key", "<api-key>")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.lightsage.com/v2/visibility/overview")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Get.new(url)
request["X-Lightsage-Api-Key"] = '<api-key>'
response = http.request(request)
puts response.read_body{
"company": {
"name": "<string>",
"domain": "<string>",
"logo_url": "<string>",
"relationship": "<string>"
},
"date_range": {
"start_date": "<string>",
"end_date": "<string>",
"granularity": "day",
"latest_run_date": "<string>",
"active_prompts_only": true
},
"has_data": true,
"snapshot": {
"recommendation_score": 123,
"recommendation_score_rank": 123,
"visibility_score": 123,
"visibility_score_rank": 123,
"share_of_voice": 123,
"share_of_voice_rank": 123,
"average_position": 123,
"average_position_rank": 123,
"total_citations": 0
},
"timeseries": {
"recommendation_score": [
{
"date": "<string>",
"value": 123
}
],
"visibility_score": [
{
"date": "<string>",
"value": 123
}
]
},
"by_platform": {
"platforms": [
{
"platform_id": "<string>",
"name": "<string>",
"icon_url": "<string>",
"mention_count": 0,
"prompt_run_count": 0
}
],
"recommendation_score": {},
"visibility_score": {},
"citations": {}
},
"competitors": [
{
"company": {
"name": "<string>",
"domain": "<string>",
"logo_url": "<string>",
"relationship": "<string>"
},
"recommendation_score": 123,
"recommendation_score_rank": 123,
"visibility_score": 123,
"visibility_score_rank": 123,
"share_of_voice": 123,
"share_of_voice_rank": 123,
"average_position": 123,
"average_position_rank": 123
}
]
}{
"detail": [
{
"loc": [
"<string>"
],
"msg": "<string>",
"type": "<string>",
"input": "<unknown>",
"ctx": {}
}
]
}Visibility
Retrieve Visibility Overview
Returns aggregate snapshot, daily trends, per-platform breakdowns, and competitor comparison. Calculated from active prompts only.
GET
/
v2
/
visibility
/
overview
Retrieve Visibility Overview
curl --request GET \
--url https://api.lightsage.com/v2/visibility/overview \
--header 'X-Lightsage-Api-Key: <api-key>'import requests
url = "https://api.lightsage.com/v2/visibility/overview"
headers = {"X-Lightsage-Api-Key": "<api-key>"}
response = requests.get(url, headers=headers)
print(response.text)const options = {method: 'GET', headers: {'X-Lightsage-Api-Key': '<api-key>'}};
fetch('https://api.lightsage.com/v2/visibility/overview', 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.lightsage.com/v2/visibility/overview",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "GET",
CURLOPT_HTTPHEADER => [
"X-Lightsage-Api-Key: <api-key>"
],
]);
$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.lightsage.com/v2/visibility/overview"
req, _ := http.NewRequest("GET", url, nil)
req.Header.Add("X-Lightsage-Api-Key", "<api-key>")
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.lightsage.com/v2/visibility/overview")
.header("X-Lightsage-Api-Key", "<api-key>")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.lightsage.com/v2/visibility/overview")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Get.new(url)
request["X-Lightsage-Api-Key"] = '<api-key>'
response = http.request(request)
puts response.read_body{
"company": {
"name": "<string>",
"domain": "<string>",
"logo_url": "<string>",
"relationship": "<string>"
},
"date_range": {
"start_date": "<string>",
"end_date": "<string>",
"granularity": "day",
"latest_run_date": "<string>",
"active_prompts_only": true
},
"has_data": true,
"snapshot": {
"recommendation_score": 123,
"recommendation_score_rank": 123,
"visibility_score": 123,
"visibility_score_rank": 123,
"share_of_voice": 123,
"share_of_voice_rank": 123,
"average_position": 123,
"average_position_rank": 123,
"total_citations": 0
},
"timeseries": {
"recommendation_score": [
{
"date": "<string>",
"value": 123
}
],
"visibility_score": [
{
"date": "<string>",
"value": 123
}
]
},
"by_platform": {
"platforms": [
{
"platform_id": "<string>",
"name": "<string>",
"icon_url": "<string>",
"mention_count": 0,
"prompt_run_count": 0
}
],
"recommendation_score": {},
"visibility_score": {},
"citations": {}
},
"competitors": [
{
"company": {
"name": "<string>",
"domain": "<string>",
"logo_url": "<string>",
"relationship": "<string>"
},
"recommendation_score": 123,
"recommendation_score_rank": 123,
"visibility_score": 123,
"visibility_score_rank": 123,
"share_of_voice": 123,
"share_of_voice_rank": 123,
"average_position": 123,
"average_position_rank": 123
}
]
}{
"detail": [
{
"loc": [
"<string>"
],
"msg": "<string>",
"type": "<string>",
"input": "<unknown>",
"ctx": {}
}
]
}Authorizations
Query Parameters
Inclusive range start; defaults to 30 days before the end date. The range may span at most 90 days.
Inclusive range end; defaults to today.
Response
Successful Response
Show child attributes
Show child attributes
Show child attributes
Show child attributes
Show child attributes
Show child attributes
Show child attributes
Show child attributes
Show child attributes
Show child attributes
Includes the primary company.
Show child attributes
Show child attributes