Product Visibility

Product Visibility Overview

Get product visibility metrics and the top tracked products. Requires an active AI Visibility subscription with API access.

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

Product Visibility Overview

cURL

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

Response

{
  "metrics": {
    "productsTracked": 0,
    "productsAnalyzed": 0,
    "observations": 0,
    "promptCoverage": null,
    "recommendationRate": null,
    "citationCoverage": null,
    "openOpportunities": 0
  },
  "topProducts": []
}

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.

Response

200 application/json

metricsobject— productsTracked, productsAnalyzed, observations, promptCoverage, recommendationRate, citationCoverage and openOpportunities. Rates are percentages or null when there are no observations.

topProductsarray— Up to 10 products with id, productName, imageUrl, visibilityStatus, mentions, recommendations, mentionRate and recommendationRate.