Skip to main content
GET
/
v1
/
products
/
{productId}
/
prompts
/
summary
AI visibility by product
curl --request GET \
  --url https://api.siteline.ai/v1/products/{productId}/prompts/summary \
  --header 'Authorization: Bearer <token>'
{
  "position": 2.5,
  "visibility": 0.42,
  "rank": 3,
  "totalCompetitors": 12
}

Documentation Index

Fetch the complete documentation index at: https://docs.siteline.ai/llms.txt

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

Authorizations

​
Authorization
string
header
required

Siteline public API key. Create one under Team settings > Public API Key.

Path Parameters

​
productId
integer
required

Product ID returned by GET /v1/products.

Example:

42

Query Parameters

​
domain
string
required

Product domain to report metrics for, such as example.com.

Example:

"example.com"

​
dateFrom
string<date-time>
required

Inclusive start timestamp in RFC3339 format.

Example:

"2026-05-01T00:00:00Z"

​
dateTo
string<date-time>
required

Inclusive end timestamp in RFC3339 format.

Example:

"2026-05-31T23:59:59Z"

​
platforms[]
string[]

Platform filters. Common values: openai, gemini, google, perplexity, google_ai_overviews, claude.

​
labelIds[]
integer[]

Prompt label IDs to filter on. Invalid IDs return 400.

Response

Aggregate prompt performance.

​
position
number | null
required

Average position of the product within AI response text across all matching prompts. null when no data is available.

Example:

2.5

​
visibility
number | null
required

Aggregate percentage of AI responses in which the product appears across all matching prompts, expressed as a decimal. null when no data is available.

Example:

0.42

​
rank
integer | null
required

Product's ranking by visibility compared to all competing products across matching prompts. null when no data is available.

Example:

3

​
totalCompetitors
integer
required

Total number of distinct competitor products appearing across matching prompt results.

Example:

12