# Searchspring Documentation > Documentation for Searchspring ## API Reference - [Welcome to the Searchspring API Reference](https://docs.searchspring.com/reference/getting-started-welcome.md): Our various Searchspring API endpoints let you integrate our advanced Site Search capability, Product Merchandising, Insights and Reporting Suite, and Personalization suite onto your storefront! - [What's new in our docs](https://docs.searchspring.com/reference/getting-started-what-is-new.md): Stay ahead of the curve! Your hub for all the latest Searchspring features and fixes. - [Searchspring Cookies](https://docs.searchspring.com/reference/searchspring-cookies.md): In all Searchspring integrations the [User Tracking](https://docs.searchspring.com/reference/searchspring-cookies#user-tracking) cookies are required for various API endpoints to primarily allow our reporting to function properly. If you are signed up for Personalized Recommendations and/or Personalized Search & Merchandising the [Personalization Tracking](https://docs.searchspring.com/reference/searchspring-cookies#personalization-tracking) cookies are required to be set. - [Overview](https://docs.searchspring.com/reference/autocomplete-module.md): This section will cover the different API endpoints that are available to build a functional Autocomplete module within your integration as well as cover the different features that are available within each endpoint. - [Trending API](https://docs.searchspring.com/reference/get-trending.md): Returns the most popular search terms from the past 90 days for your site. - [Suggest API](https://docs.searchspring.com/reference/get-suggest.md): If applicable, will return a suggestion and alternate suggestions to be displayed to the shopper as alternate search queries to pass to the [Autocomplete API](https://docs.searchspring.com/reference/get-autocomplete) to source results. - [Autocomplete API](https://docs.searchspring.com/reference/get-autocomplete.md): Used to receive data to build a preview of results to the shopper within the [Autocomplete Module](https://docs.searchspring.com/reference/autocomplete-module) based on the typed value in the searchbar. - [Overview](https://docs.searchspring.com/reference/autocomplete-tracking-guide.md) - [addtocart](https://docs.searchspring.com/reference/autocomplete-addtocart.md): /beacon/v2/{siteId}/autocomplete/addtocart

Shopper adds a Searchspring autocomplete result to the cart via a `Quick Add to Cart` button in the Autocomplete Module. **If frontend `Quick Add to Cart` is not implemented, omit usage of this endpoint.** - [clickthrough](https://docs.searchspring.com/reference/autocomplete-clickthrough.md): /beacon/v2/{siteId}/autocomplete/clickthrough

Shopper clicks on a Searchspring autocomplete search result rendered in the Autocomplete Module, and is taken to the product detail page (PDP). - [impression](https://docs.searchspring.com/reference/autocomplete-impression.md): /beacon/v2/{siteId}/autocomplete/impression

Shopper views the rendered Searchspring autocomplete results in the Autocomplete Module. - [redirect](https://docs.searchspring.com/reference/autocomplete-redirect.md): /beacon/v2/{siteId}/autocomplete/redirect

Shopper types in the searchbar and an Autocomplete Module with Searchspring autocomplete search results are rendered, but a redirect URL is returned in the Autocomplete API response and the shopper is redirected to the returned redirect URL. - [render](https://docs.searchspring.com/reference/autocomplete-render.md): /beacon/v2/{siteId}/autocomplete/render

Shopper types in the searchbar and an Autocomplete Module with Searchspring autocomplete search results are rendered. - [Search API](https://docs.searchspring.com/reference/get-search.md): Returns search results, filters, sort options, pagination, active filters (if active), configured merchandising data (if triggered), and spell correction information to build a results page. See [Search Result Pages](https://docs.searchspring.com/reference/search-result-pages), [Category Result Pages](https://docs.searchspring.com/reference/category-result-pages), and [Content Results](https://docs.searchspring.com/reference/content-results) to see where this endpoint is used. - [Meta API](https://docs.searchspring.com/reference/get-meta.md): Returns static search configuration data, most notably, badge configurations - [Overview](https://docs.searchspring.com/reference/search-tracking-guide.md) - [addtocart](https://docs.searchspring.com/reference/search-addtocart.md): /beacon/v2/{siteId}/search/addtocart

This event should be triggered when a shopper lands on a search results page where Searchspring search results are rendered, and adds a result to the cart via a `Quick Add to Cart` button. **If frontend `Quick Add to Cart` is not implemented, omit usage of this endpoint.** - [clickthrough](https://docs.searchspring.com/reference/search-clickthrough.md): /beacon/v2/{siteId}/search/clickthrough

This event should be triggered when a shopper lands on a search results page, clicks on a Searchspring search result, and will be taken to the product detail page (PDP). - [impression](https://docs.searchspring.com/reference/search-impression.md): /beacon/v2/{siteId}/search/impression

This event should be triggered when a shopper lands on a search results page and Searchspring search results receive an impression. - [redirect](https://docs.searchspring.com/reference/search-redirect.md): /beacon/v2/{siteId}/search/redirect

This event should be triggered after a shopper lands on a search results page where Searchspring search results are rendered, but a redirect URL is returned in the Search API response and the shopper is redirected to the returned redirect URL. - [render](https://docs.searchspring.com/reference/search-render.md): /beacon/v2/{siteId}/search/render

This event should be triggered when a shopper lands on a search results page and Searchspring search results are rendered. - [Category API](https://docs.searchspring.com/reference/get-category.md): Returns category page results, filters, sort options, pagination, active filters (if active), configured merchandising data (if triggered), and spell correction information to build a category results page. See [Category Result Pages](https://docs.searchspring.com/reference/category-result-pages) to see where this endpoint is used. This endpoint should be used specifically for category page requests instead of the Search API endpoint. - [Meta API](https://docs.searchspring.com/reference/get-meta-category.md): Returns static search configuration data, most notably, badge configurations - [Overview](https://docs.searchspring.com/reference/category-tracking-guide.md) - [addtocart](https://docs.searchspring.com/reference/category-addtocart.md): /beacon/v2/{siteId}/category/addtocart

Shopper lands on a category results page where Searchspring results are rendered, and adds a result to the cart via a `Quick Add to Cart` button. **If frontend `Quick Add to Cart` is not implemented, omit usage of this endpoint.** - [clickthrough](https://docs.searchspring.com/reference/category-clickthrough.md): /beacon/v2/{siteId}/category/clickthrough

Shopper lands on a category results page, clicks on a Searchspring result, and will be taken to the product detail page (PDP). - [impression](https://docs.searchspring.com/reference/category-impression.md): /beacon/v2/{siteId}/category/impression

Shopper lands on a category results page and Searchspring results receive an impression. - [render](https://docs.searchspring.com/reference/category-render.md): /beacon/v2/{siteId}/category/render

Shopper lands on a category results page and Searchspring results are rendered. - [Advanced Merchandising](https://docs.searchspring.com/reference/advanced-merchandising.md): Merchandising campaigns in Searchspring influences what the Autocomplete or Search API would naturally return in the API response based on merchandising changes that are made within the configured merchandising campaign. These features are included in Searchsprings Expert and Advanced plan levels. If you are interested in these features please reach out to your Searchspring Point of Contact for more information. - [Overview](https://docs.searchspring.com/reference/personalization-overview.md): Learn how the Preflight API optimizes personalization performance by caching user context ahead of time. - [Preflight API](https://docs.searchspring.com/reference/get-preflight.md): If your account is configured to utilize [Personalized Search & Merchandising](https://help.searchspring.net/hc/en-us/articles/4405042906779-Personalized-Search-Merchandising), this endpoint is required to feed into the feature. In the integration, the moment the data points for "shopper", "cart", or "lastViewed" query string parameters are assigned a value, a Preflight request will need to be sent _before_ a request to the Autocomplete or Search API endpoint is sent. ***The GET method will support up to 2048 characters, if there are more characters use the [POST method](https://docs.searchspring.com/reference/post-preflight)***. - [Preflight API](https://docs.searchspring.com/reference/post-preflight.md): If your account is configured to utilize [Personalized Search & Merchandising](https://help.searchspring.net/hc/en-us/articles/4405042906779-Personalized-Search-Merchandising), this endpoint is required to feed into the feature. In the integration, the moment the data points for "shopper", "cart", or "lastViewed" query string parameters are assigned a value, a Preflight request will need to be sent _before_ a request to the Autocomplete or Search API endpoint is sent. ***The POST method will support more than 2048, if there are less characters use the [GET method](https://docs.searchspring.com/reference/get-preflight)***. - [Bundles](https://docs.searchspring.com/reference/bundles.md): A Bundle profile gives you cross sell recommendations and prepends the seed item for easy display - [Personalized Recommendations API](https://docs.searchspring.com/reference/get-recommendations.md): Will return recommended products queried from a configured personalized recommendations profile. Returned results will be personalized to the shopper. - [Personalized Recommendations API](https://docs.searchspring.com/reference/post-recommendations.md): Will return recommended products queried from a configured personalized recommendations profile. Returned results will be personalized to the shopper. - [Overview](https://docs.searchspring.com/reference/recommendations-tracking-guide.md) - [addtocart](https://docs.searchspring.com/reference/recommendations-addtocart.md): /beacon/v2/{siteId}/recommendations/addtocart

Shopper adds a Searchspring personalized recommendation result to the cart via a `Quick Add to Cart` button in the rendered product card. **If frontend `Quick Add to Cart` is not implemented, omit usage of this endpoint.** - [clickthrough](https://docs.searchspring.com/reference/recommendations-clickthrough.md): /beacon/v2/{siteId}/recommendations/clickthrough

Shopper clicks on a rendered Searchspring personalized recommended result, and is taken to the product detail page (PDP). - [impression](https://docs.searchspring.com/reference/recommendations-impression.md): /beacon/v2/{siteId}/recommendations/impression

Shopper scrolls into view rendered Searchspring personalized recommended results. Results sent ***must*** only be results in the shoppers view at the time of the event. - [render](https://docs.searchspring.com/reference/recommendations-render.md): /beacon/v2/{siteId}/recommendations/render

Shopper navigates to a page where Searchspring personalized recommendations are requested from the [Personalized Recommendations API endpoint](https://docs.searchspring.com/reference/get-recommendations) and rendered on the page. - [Finder API](https://docs.searchspring.com/reference/get-finder.md): Used to source filters to build a [Product Finder Module](https://docs.searchspring.com/reference/product-finder-module). - [Overview](https://docs.searchspring.com/reference/beacon-tracking.md) - [Context Object Guide](https://docs.searchspring.com/reference/context-object-guide.md) - [Impression Tracking Implementation Guide](https://docs.searchspring.com/reference/impression-tracking-guide.md) - [Banner ID Extraction for Tracking](https://docs.searchspring.com/reference/banner-id-extraction-guide.md) - [Overview](https://docs.searchspring.com/reference/shopping-platform-tracking-guide.md) - [add](https://docs.searchspring.com/reference/cart-add.md): /beacon/v2/{siteId}/cart/add

Shopper adds additional item quantities to an item in the cart via the cart page or a slideout cart. - [remove](https://docs.searchspring.com/reference/cart-remove.md): /beacon/v2/{siteId}/cart/remove

Shopper removes an item or reduces an items quantity in the cart via the cart page or a slideout cart. - [transaction](https://docs.searchspring.com/reference/order-transaction.md): /beacon/v2/{siteId}/order/transaction

Shopper has completed an order transaction. Tracks order contents. - [pageview](https://docs.searchspring.com/reference/product-pageview.md): /beacon/v2/{siteId}/product/pageview

Shopper has navigated to a product detail page (PDP). - [login](https://docs.searchspring.com/reference/login.md): /beacon/v2/{siteId}/shopper/login

Shopper successfully logs into their account. - [Express Sync Indexing Requirements, Use Cases, and Caveats](https://docs.searchspring.com/reference/express_indexing_requirements.md): The Searchspring express sync indexing API is not intended to fully replace the Searchspring feed bulk indexing. It is only intended to keep product data up to date between bulk indexing runs. Below is a list of best practices when using Express sync indexing to ensure everything runs smoothly. - [Express Sync Indexing API](https://docs.searchspring.com/reference/live_indexing_api.md): Before using this endpoint please review our [Express Indexing Requirements, Use Cases, and Caveats](https://docs.searchspring.com/reference/express_indexing_requirements) documentation. - [API Integration Checklist](https://docs.searchspring.com/reference/api_integration_checklist.md) - [API installation instructions for Segmented Merchandising](https://docs.searchspring.com/reference/segmented_merchandising_install_api.md) - [Integrating Banners](https://docs.searchspring.com/reference/integrating_banners.md): Here we will go over how to read the Search API response to check if a merchandising campaign is triggered, how to locate returned banner content, and how to render the banners on the page. If you aren't already familiar with configuring merchandising banners and their placement, please refer to [this article](https://searchspring.zendesk.com/hc/en-us/articles/115002601543-Banners) before moving into the contents of this page. - [Autocomplete API Integrations](https://docs.searchspring.com/reference/input_suggest_autocomplete_search_flow.md) - [Beacon 2.0 Technical Migration Guide](https://docs.searchspring.com/reference/beacon-migration-guide.md): Your one stop shop on the key technical changes between Beacon 1.0 and Beacon 2.0 🚀