USusesapient
Visibility

Retrieve Prompt Visibility Report

Changed on

Returns the prompt visibility report for the organization.

Returns an overall summary, topic rows, and nested active prompt rows. Each row includes recommendation score, recommendation score rank, visibility score, average position, owned-domain citations, and prompt runs for the selected date range. Active prompts without runs remain in the response with null visibility metrics and zero counts.

get/v1/visibility/prompts

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

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