Indexly

Product Visibility

Product Readiness

Get the latest readiness audit for each active product. Requires an active AI Visibility subscription with API access.

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

Product Readiness

cURL

curl --request GET \
  --url 'https://app.indexly.ai/api/v1/product-visibility/SITE_ID/readiness' \
  --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.

pageintegerdefault: 1

Page number, from 1 to 100000.

pageSizeintegerdefault: 20

Results per page, from 1 to 50.

Response

200 application/json
dataarray— Entries contain productId, product, url and audit. The audit is null if no readiness result exists.
paginationobject— Contains page, pageSize, total and pages (total page count).