Skip to main content
GET
/
v1
/
products
/
{productId}
/
prompts
AI visibility by prompt
curl --request GET \
  --url https://api.siteline.ai/v1/products/{productId}/prompts \
  --header 'Authorization: Bearer <token>'
[
  {
    "promptText": "best observability platforms",
    "platform": "openai",
    "domain": "example.com",
    "position": 2.5,
    "visibility": 0.42,
    "rank": 3,
    "runCount": 120,
    "labels": [
      {
        "id": 7,
        "name": "Commercial"
      }
    ]
  }
]

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

Array of prompt metrics.

​
promptText
string
required
Example:

"best observability platforms"

​
platform
string
required
Example:

"openai"

​
domain
string
required
Example:

"example.com"

​
position
number | null
required

Average position of the product within AI response text for this prompt. For example, a position of 1 means the product was mentioned first. null when no data is available.

Example:

2.5

​
visibility
number | null
required

Percentage of AI responses in which the product appears for this prompt, expressed as a decimal (e.g. 0.42 = 42%). null when no data is available.

Example:

0.42

​
rank
integer | null
required

Product's ranking by visibility compared to all products appearing in this prompt's results. A rank of 1 means highest visibility. null when no data is available.

Example:

3

​
runCount
integer | null
required

Total number of prompt runs recorded in the period. null when no data is available.

Example:

120

​
labels
object[]
required