Skip to main content
GET
Retrieve Current Visibility

Authorizations

X-Lightsage-Api-Key
string
header
required

Query Parameters

start_date
string<date>

Optional start date. Defaults to 30 days before the end date.

end_date
string<date>

Optional end date. Defaults to today.

Response

Successful Response

company
PublicCompany · object
required
start_date
string
required

Start date used for the calculation.

end_date
string
required

End date used for the calculation.

has_data
boolean
required

Whether the selected date range contains visibility data.

visibility_score
number | null

Current visibility score for the selected date range, from 0 to 1.

visibility_score_rank
integer | null

Rank by visibility score among tracked companies.

share_of_voice
number | null

Current share of voice for the selected date range, from 0 to 1.

share_of_voice_rank
integer | null

Rank by share of voice among tracked companies.

average_position
number | null

Average mention position for the selected date range.

average_position_rank
integer | null

Rank by average mention position among tracked companies.

date
string | null

Latest prompt-run date included in the calculation.

active_prompts_only
boolean
default:true

Whether only currently active prompts were included.