Skip to main content
GET
/
visibility
Visibility scores for the latest usable run
curl --request GET \
  --url https://openlens.com/api/visibility \
  --header 'Authorization: Bearer <token>'
[
  {
    "brandId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "brandName": "<string>",
    "isOwn": true,
    "overall": 123,
    "byPlatform": {},
    "avgPosition": 123,
    "mentionCount": 123,
    "totalPlatformResponses": 123,
    "sentimentBreakdown": {
      "positive": 123,
      "neutral": 123,
      "negative": 123
    }
  }
]

Documentation Index

Fetch the complete documentation index at: https://docs.openlens.com/llms.txt

Use this file to discover all available pages before exploring further.

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.

​
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