Product Visibility

Product Tracked Prompts

List product visibility prompts. Requires an active AI Visibility subscription with API access.

GET/api/v1/product-visibility/:siteId/prompts

Product Tracked Prompts

cURL

curl --request GET \
  --url 'https://app.indexly.ai/api/v1/product-visibility/SITE_ID/prompts' \
  --header 'X-API-Key: YOUR_API_KEY'

Response

{
  "data": [],
  "pagination": {
    "page": 1,
    "pageSize": 20,
    "total": 0,
    "pages": 0
  }
}

Authorizations

X-API-Keystringheaderrequired

API key from Settings → API Access in the Indexly dashboard.

Path parameters

siteIdstringrequired

Site ID belonging to your organization.

Query parameters

productstringdefault: all

Filter by an active product ID, or use all.

searchstring

Search text (up to 200 characters). Products match name, brand, SKU or ASIN; discovered products match name, brand or SKU; prompts, analysis and competitors match prompt text; sentiments match theme, prompt or product name.

enabledboolean

Filter prompts by true or false.

pageintegerdefault: 1

Page number, from 1 to 100000.

pageSizeintegerdefault: 20

Results per page, from 1 to 50.

Response

200 application/json

dataarray— Prompts include id, promptText, targetProductIds, enabled, promptType, priorityScore, createdAt and updatedAt.

paginationobject— Contains page, pageSize, total and pages (total page count).