Product Visibility

Product Competitors

Get competitor insights grouped by tracked product and prompt. Requires an active AI Visibility subscription with API access.

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

Product Competitors

cURL

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

modelstringdefault: all

Filter by AI model. For competitors and sentiments the model must occur in a site run.

marketstringdefault: all

Filter by the target market of the analysis run.

dayinteger

Look-back window in days, from 1 to 3650. Invalid values use the configured default (normally 90 days).

pageintegerdefault: 1

Page number, from 1 to 100000.

pageSizeintegerdefault: 20

Results per page, from 1 to 50.

Response

200 application/json

dataarray— Groups include id, name, imageUrl, prompts and aggregated slots. Prompts include id, prompt, targetProductIds, resultId, platform and ranked slots.

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