Search
| Resource | Method | Endpoint | Description |
|---|---|---|---|
| Search | Post | /search | Returns the first 20 refinement values for any given navigation |
| Search Refinements | Get | /search/refinements | Returns up to 10,000 refinements for the navigation, and will append the original query as well |
| Upload Data | Post | /upload/stream | Returns a HTTP/1.1 200 OK response if all of the data is uploaded correctly and inserted into the index without any errors or warnings. |
SAYT
| Resource | Method | Endpoint | Description |
|---|---|---|---|
| SAYT Search | Get | /sayt/search | Returns navigation matches and search terms from the data generated through uploaded data |
| SAYT Products | Get | /sayt/products | Returns product matches from the data generated through uploaded data |
Recommendations
| Resource | Method | Endpoint | Description |
|---|---|---|---|
| Popular Metadata | Post | /recommendations/metadata/_getPopular | Returns metadata that are the most commonly seen in the window specified. Size defaults to 10, resulting in a response containing all of the value counts for 10 metadata keys. |
| Products Bought Together | Post | /recommendations/products/_getBoughtTogether | Returns products that are bought together (in the same cart) in the window specified. |
| Popular Products | Post | /recommendations/products/_getPopular | Returns products that are the most commonly seen in the window specified. |
| Recent Products | Post | /recommendations/products/_getRecent | Returns products that are the most recent for the event type and/or window specified. |
| Trending Products | Post | /recommendations/products/_getTrending | Returns products that are over-represented in the window specified with comparison to a larger background set. |
| Popular Refinements | Post | /recommendations/refinements/_getPopular | Returns refinements that are the most commonly seen in the window specified. |
| Popular Searches | Post | /recommendations/searches/_getPopular | Returns search queries that are the most commonly seen in the window specified. |
| Recent Searches | Post | /recommendations/searches/_getRecent | Returns the most recently sent search queries in the window specified. |
| Trending Searches | Post | /recommendations/searches/_getTrending | Returns search queries that are over-represented in the window specified with comparison to a larger background set. The background set is 8-times the window size. |
| Similar Searches | Post | /recommendations/searches/similar | Recommends products which other users searched related to a given product (parent product). |
| Also Bought | Post | /recommendations/products/alsoBought | Recommends products which other users bought related to a given product (parent product). |
| Also Viewed | Post | /recommendations/products/alsoViewed | Recommends products which other users viewed related to a given product (parent product). |
Analytics
| Resource | Method | Endpoint | Description |
|---|---|---|---|
| Search | Post | /api/analytics/v1/searches | Returns all details related to the search term such as the performance, navigations, and retrieved products. |
| Search Navigations | Post | /api/analytics/v1/searches/navigations | Returns the navigation and refinements for each search term such as the total navigations clicked, navigations per unique search, and navigations per product view. |
| Null Search Terms | Post | /api/analytics/v1/searches/nulls | Returns the search terms that returned no results. Size is limited to 1000 results. |
| Search Term Performance | Post | /api/analytics/v1/searches/performance | Returns the performance of a search term such as the total items ordered, refinements ratio, click ratio, and conversion score. |
| Search Products | Post | /api/analytics/v1/searches/products | Returns the popular products for each search term including details such as the total views, total orders that got added to the cart, and the average position of the product when it was ordered. |
| Trending Searches | Post | /api/analytics/v1/searches/trending | Returns the search terms that were trending over the past week/month as well as the volume in the past 7 days, 30 days, 30 days (before the past 7) and 90 days (before the past 30). |
Admin
| Resource | Method | Endpoint | Description |
|---|---|---|---|
| Area Promotion | Get | /promoteArea | Promotes Command Center configurations from one area to another |
| Null Searches | Post | /reporting/searches/_getNull | Returns searches that resulted in zero results being displayed to the shopper in the window specified. |
| Products Added to Cart | Post | /stats/_getProductCartAdds | Returns a list of the product most commonly added to cart and how many times they were added. |
| Products Ordered | Post | /stats/_getProductOrders | Returns a list of the most popularly ordered products and how many times they were ordered. |
| Products Views | Post | /stats/_getProductViews | Returns a list of the most popularly viewed products and how many times they were viewed. Views by bots (googlebot, bingbot, etc) will be filtered out by default. |
| Import Bulk Navs | Post | /upload/bulk | Create navigations without having to configure them via Command Center. |
| Status of Imported Bulk Navs | Post | /navigations | Returns the status (count per area and total count) of the navigations uploaded via the API. |
| Delete Imported Bulk Navs | Delete | /navigations | Removes the imported bulk navigations from the specified area. |