Skip to main content
GET
Visibility scores for the latest usable or selected run

Authorizations

Authorization
string
header
required

Clerk API key. Create one from your account settings under API Keys.

Query Parameters

projectId
string<uuid>
required

Project id. Required on all data endpoints.

runId
string<uuid>

Completed prompt run ID. Omit to use the project's latest usable run; use GET /prompts/runs to list historical run IDs.

topicId
string<uuid>
type
enum<string>
default:overview
Available options:
overview,
topics,
attributes
promptAttributes
string

Comma-separated list of attribute filters. Accepts both built-in attributes (e.g. pricing, comparisons) and project-specific custom attributes.

Response

One of: array of VisibilityScore, array of TopicVisibilitySummary, TopicVisibility, or array of AttributeBreakdown depending on type.

brandId
string<uuid>
required
brandName
string
required
isOwn
boolean
required
overall
number
required

Mention rate as a percentage (0–100).

byPlatform
object
required

Per-platform mention rate, keyed by platform id.

avgPosition
number
required
mentionCount
integer
required
totalPlatformResponses
integer
required
dominantSentiment
enum<string>
required
Available options:
positive,
neutral,
negative
sentimentBreakdown
object
required