AI Suite — API Reference

Analytics, recommendations, search, and more

59 endpoints across 8 tags.

Search

• GET /search/v2/indices/{indexId}/query — Full-text items search
• POST /search/v2/indices/{indexId}/query — Full-text items search
• GET /search/v2/indices/{indexId}/query/explain — Explained full-text items search
• POST /search/v2/indices/{indexId}/query/explain — Explained full-text items search
• GET /search/v2/indices/{indexId}/autocomplete — Autocomplete items search
• POST /search/v2/indices/{indexId}/autocomplete — Autocomplete items search
• GET /search/v2/indices/{indexId}/autocomplete/explain — Explained autocomplete items search
• POST /search/v2/indices/{indexId}/autocomplete/explain — Explained autocomplete items search
• GET /search/v2/indices/{indexId}/explain-match — Searchable attributes match
• GET /search/v2/indices/{indexId}/deleted-searches — Get deleted searches
• POST /search/v2/indices/{indexId}/deleted-searches — Soft-delete a recent search
• GET /search/v2/indices/{indexId}/recent-searches — Get recent searches

Visual Search

• GET /search/v2/indices/{indexId}/visual — Visual items search
• POST /search/v2/indices/{indexId}/visual — Visual items search
• GET /search/v2/indices/{indexId}/visual/explain — Explained visual items search
• POST /search/v2/indices/{indexId}/visual/explain — Explained visual items search

Search Stats

• GET /search/v2/indices/{indexId}/stats/queries/summary — Get queries stats summary
• GET /search/v2/indices/{indexId}/stats/queries/top — Get top query statistics
• GET /search/v2/indices/{indexId}/stats/filters/summary — Get filters stats
• GET /search/v2/indices/{indexId}/stats/rules/summary — Get rules stats
• GET /search/v2/indices/stats/queries/summary — Get queries summary for multiple indices

Recommendation campaigns

• GET /recommendations/v2/campaigns — Get all recommendation campaigns
• POST /recommendations/v2/campaigns — Create a recommendation campaign
• GET /recommendations/v2/campaigns/{campaignId} — Get recommendation campaign details
• POST /recommendations/v2/campaigns/{campaignId} — Update a recommendation campaign
• DELETE /recommendations/v2/campaigns/{campaignId} — Delete a recommendation campaign
• POST /recommendations/v2/campaigns/state — Change campaigns' states
• POST /recommendations/v2/campaigns/{campaignId}/copy — Copy a recommendation campaign
• GET /recommendations/v2/campaigns/simplified — Get simplified recommendation campaigns

Recommendation statistics

• POST /recommendations/v2/campaigns/stats — Get recommendation campaign statistics
• GET /recommendations/v2/campaigns/stats/global — Get global recommendation campaign statistics
• GET /recommendations/v2/campaigns/{campaignId}/stats — Get recommendation campaign statistics
• GET /recommendations/v2/campaigns/{campaignId}/products/stats — Get statistics for top items in a campaign

Recommendations

• GET /recommendations/v2/recommend/campaigns/{campaignIdentifier} — Get recommendations by campaign
• POST /recommendations/v2/recommend/campaigns — Get recommendations by campaign
• POST /recommendations/v2/recommend/campaigns/{campaignIdentifier}/by/{identifierName} — Get recommendations by campaign and profile identifier
• POST /recommendations/v2/recommend/campaigns/preview — Preview campaign recommendations
• GET /recommendations/v2/recommend/items/users/{clientUuid} — Personalized recommendations
• POST /recommendations/v2/recommend/items/users/{clientUuid} — Personalized recommendations
• POST /recommendations/v2/recommend/items/users/{clientUuid}/sections — Section recommendations
• POST /recommendations/v2/recommend/items/users/{clientUuid}/attributes — Attribute recommendations
• GET /recommendations/v2/recommend/items/users/{clientUuid}/last — Last viewed recommendations
• POST /recommendations/v2/recommend/items/users/{clientUuid}/last — Last viewed recommendations
• GET /recommendations/v2/recommend/items/users/{clientUuid}/aggregates/{aggregateUUID} — Recent interactions recommendations
• POST /recommendations/v2/recommend/items/users/{clientUuid}/aggregates/{aggregateUUID} — Recent interactions recommendations
• GET /recommendations/v2/recommend/items/metric — Scoring by metric
• POST /recommendations/v2/recommend/items/metric — Scoring by metric
• GET /recommendations/v2/recommend/items/complementary — Complementary items for a cart
• POST /recommendations/v2/recommend/items/complementary — Complementary items for a cart
• GET /recommendations/v2/recommend/items/{itemId}/complementary — Complementary items
• POST /recommendations/v2/recommend/items/{itemId}/complementary — Complementary items
• GET /recommendations/v2/recommend/items/{itemId}/similar — Similar items
• POST /recommendations/v2/recommend/items/{itemId}/similar — Similar items
• GET /recommendations/v2/recommend/items/{itemId}/similar/visual — Visually similar
• POST /recommendations/v2/recommend/items/{itemId}/similar/visual — Visually similar
• GET /recommendations/v2/recommend/items/next-interaction — Next interaction
• POST /recommendations/v2/recommend/items/next-interaction — Next interaction

Time Optimizer

• POST /activity-time-estimator/v1/query-model — Generate activity time predictions

Item filters

• POST /items/v2/filter/validate — Validate item filter

Back to all API categories