USusesapient
Visibility

Retrieve Current Visibility

Changed on

Returns current visibility metrics for the organization.

Returns recommendation score, visibility score, ranks, and date-range metadata for the configured primary company. The calculation uses currently active prompts only. When the selected range has no prompt-run data, metric values are null and has_data is false.

get/v1/visibility/current

Request

  • Base URL
    https://api.lightsage.com
  • Auth
    API key in header X-Lightsage-Api-Key

Query parameters

start_datestring date

The inclusive start date in YYYY-MM-DD format. Defaults to 30 days before end_date. The range may span at most 90 days.

end_datestring date

The inclusive end date in YYYY-MM-DD format. Defaults to today.

Response

Successful Response

recommendation_scorenumber nullable

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_rankinteger nullable
visibility_scorenumber nullable

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_rankinteger nullable
share_of_voicenumber nullable

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_rankinteger nullable

Rank by share_of_voice among tracked companies, highest first.

average_positionnumber nullable

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

average_position_rankinteger nullable
datestring nullable

Latest prompt-run date in the range.

start_datestring required
end_datestring required
active_prompts_onlyboolean
has_databoolean required

Changes

  • 2c64a77a3936Revision changes
    • info

      added the optional property to the response with the status

    • info

      added the optional property to the response with the status

    • info

      added the optional property to the response with the status

    • info

      added the optional property to the response with the status