Skip to main content
GET
AI-visibility overview

Authorizations

Authorization
string
header
required

A workspace API key issued in Settings → Developer, sent as Bearer sk_….

Query Parameters

rangeDays
number
default:30

The analytics window in days: 7, 30, or 90.

Example:

30

Response

The visibility overview.

The analytics dashboard model for the selection: the same numbers the dashboard shows. Percentages are 0-100; a null value means unavailable, never zero. Read metricDefinitions before quoting a number.

project
object
required
selection
object
required
metricSource
enum<string>
required
Available options:
analytics_dashboard
metricDefinitions
object
required

How to read the numbers; quote these, do not infer.

client
object
required
window
object
required
providers
object[]
required
overview
object
required
trackedPrompts
integer
required

The same as promptsTracked (kept for older clients).

promptsTracked
integer
required

Tracked (non-archived) prompts in the selection, answered or not. A prompt added since the last scan counts here before it has any answer.

promptsMeasured
integer
required

Tracked prompts with at least one answer in the window. Every rate (visibilityScore, citationShare, leaderboard) is computed on these prompts' answers, not on promptsTracked.

lastScanAt
string | null
required
nextScanAt
string | null
required
researchSnapshot
object

Present when the numbers come from a saved research snapshot rather than live scans.

metricNotes
object

Per-column caveats, keyed by section.field.

sectionNotices
object

Degradation notices per section; absent when the section is complete.