Skip to main content
GET
Retrieve Current Visibility

Authorizations

X-Lightsage-Api-Key
string
header
required

Query Parameters

start_date
string<date>

Inclusive range start; defaults to 30 days before the end date. The range may span at most 90 days.

end_date
string<date>

Inclusive range end; defaults to today.

Response

Successful Response

company
PublicCompany · object
required
start_date
string
required
end_date
string
required
has_data
boolean
required
recommendation_score
number | null

Mean recommendation strength across successful prompt runs, from 0 to 1. Each run contributes the company's recommendation strength (0 to 1) when it is mentioned and 0 when it is not. Failed provider runs are excluded. null unless the organization turns on Recommendation Score under Settings › Navigation.

recommendation_score_rank
integer | null
visibility_score
number | null

Fraction of successful prompt runs that mention the company, from 0 to 1; for example, 0.25 means one in four runs. Failed provider runs are excluded.

visibility_score_rank
integer | null
share_of_voice
number | null

The company's share of all mentions of tracked companies (your company plus configured competitors) in the same prompt runs, from 0 to 1; tracked companies add up to 1. Each company counts once per run. null for companies you do not track. Not the share_of_voice field removed in October 2026, which held the mention rate now returned as visibility_score.

share_of_voice_rank
integer | null

Rank by share_of_voice among tracked companies, highest first.

average_position
number | null

Mean mention position in AI responses; 1 is first and lower is better.

average_position_rank
integer | null
date
string | null

Latest prompt-run date in the range.

active_prompts_only
boolean
default:true