Jump to Content
Status
Support
Guides
Developers
Changelog
Roadmap
E-Learning
Status
Support
Tweakwise.com
Tweakwise App
Contact
Developers
Search
Tweakwise.com
Tweakwise App
Contact
Guides
Developers
Changelog
Roadmap
E-Learning
Multilingual installation
All
Pages
Start typing to search…
JUMP TO
📝 Overview
Overview
TLS Support
🎨 Integrations
Tweakwise API
Essentials
Search
Suggestions
Search phrase suggestions
Item suggestions (new)
Products (classic)
Commerce Pages
Recommendations
Guided Selling
Facets
Categories
Color swatches
Slider
Bucket slider
Search in filters
Filtering results
Items
Sorting, ordering and paging
Language Support
How to
Override App Configuration
Use request parameters
Personalization & A/B testing
Pass data to External Data provider
Tweakwise JS
Getting started
Essentials
Search & Commerce Pages
Search
Search + Suggestions
Instant Search
Commerce Pages
Google Analytics
Insights
Language support
Options
Events
Defaults
Personalization
Disable auto initialization
Suggestions
Options
Category suggestion navigation
Facet suggestion navigation
Language support / translations
Migrating from instant search to suggestions
Commerce Pages
Recommendations
Options
Events
Guided Selling
Options
Events
Guided Selling - Customize results
Guided Selling - Measuring the Funnel
How to
Plugin Studio Look & Feel
Copy Plugin Studio configuration
Creating Plugin Studio tiles
Deploy Plugin Studio
How to - Add to cart
How to - Add to favorites / wishlist
How to - Implement the Search event in GA4
How to - Extend color swatches
How to - Implement realtime pricing
How to - Implement realtime delivery indication
How to - Measure impressions using GA4
How to - Show pricing for authenticated users only
How to - Use request parameters
How to - Override builder, sorting & filter templates
How to - Pass data to External Data provider (JS)
How to - Modify visual tile
How to - Customize the No-Results Page
How to - Add a Black Friday label to your tile
How to - Add responsive support to visuals
How to - Control page size in Tweakwise JS
Impact on SEO
Typescript
Known issues
Upgrade Guide
🧩 Commerce Platforms
Magento Platform
Data sync
Magento-Native integration
Getting started
Search + Suggestions
Commerce Pages
Recommendations
Magento + Tweakwise JS
Getting started
Search + Suggestions
Commerce Pages
Recommendations
Guided Selling
Event Tag
How to
Configure the Export extension
Configure the Magento Tweakwise Frontend Extension
Configure the Attribute Landing Page extension
Configure Recommendations in Magento
Display visual components in the lister page
Apply request parameters
Show a customer specific catalog
Use grouped products feature in Magento
Extend the feed created by Magento2TweakwiseExport
Use color swatches in Magento 2
Switch from Autocomplete to Suggestions
Enable Personalization
Frequently Asked Questions
How are article numbers determined?
How to add canonical URLs?
Which stock is uploaded for configurable products?
Which attributes are exported?
How to force an updated XML feed?
How do I schedule an export?
How do I set the SEO strategy?
Can I include the stock percentage in the feed?
Does Tweakwise use Magento visibility settings?
Magento adoption matrix
Troubleshooting
Shopify
Data sync
Regular installation
Essentials
Search + Suggestions
Commerce Pages
Recommendations
Multilingual installation
Essentials
Search + Suggestions
Commerce Pages
Recommendations
Event Tag & Personalisation
How to
Support add to cart
Support favorites/wishlist
Set up collection hierarchy
Shopify - Support customer specific pricing
Creating API credentials
Shopware
Getting started
Data sync
Configure the Tweakwise feed with Shopware
Generate the Tweakwise feed with Shopware
Feed reference + customizations
Search
Commerce Pages
Recommendations
Configure Recommendations in shoppingcart
Event Tag & personalization
How to
Configure a new frontend
Migrate your plugin from classic to Plugin Studio
Exclude Data from Out-of-Stock Products or Variants
Shopware Support Policy
Shopware adoption matrix
Troubleshooting
No search results and lister pages
Sana Commerce
Getting started
Recommendations
Sana adoption matrix
Vendre
Vendre adoption matrix
Feature adoption
🗃️ Getting data in Tweakwise
Overview
Backend API
XML Feed
Create an XML feed
Validate a feed
Make a feed available
Secure a feed
Import a feed
Import single attribute in Tweakwise
Import products in Tweakwise
Import categories in Tweakwise
Import content in Tweakwise
Channable
Product feed using Channable
Product feed with custom hierarchy using Channable
Visual feed using Channable
Attribute import using Channable
✨ Personalization
About
Profiles
How to use
Personalization in API Requests
Personalization in Emails
A/B Testing Personalization with Builder
🏷️ Event Tag
Event Tag Introduction
Event Tag - Client side
Event Tag - Server side
Events & parameters
Tracking and Consent
Delivery API
Introduction
Autocomplete
Autocomplete
get
Grouped autocomplete
get
Catalog
Filter templates
get
Sorting templates
get
Builders
get
Featured recommendations
get
Product recommendations
get
Product recommendations groups
get
Guided Selling setups
get
Languages
get
Category tree
Category tree
get
Facets
Facets
get
Facet attributes
get
Feed
Feed
get
Guided selling
Compare
get
Funnel
get
Instance
Instance
get
Navigation
Navigation
get
Grouped navigation
get
Navigation search
Search
get
Grouped search
get
Products
Products
get
Product
get
Redirects
Redirects
get
Recommendations
Product recommendations
get
Product recommendations single rule
get
Product recommendations multi rule
get
Featured products
get
Optional parameters
Searchbanners
searchbanners
get
Suggestions
Suggestions
get
Suggestions grouped
get
Suggestion products
get
Suggestion products grouped
get
Suggestion items
get
Suggestion items grouped
get
Tweakwise Backend API
Introduction
Authentication
A/B testing
Get all A/B tests
get
Update A/B test
put
Create a new A/B test
post
Get A/B test
get
Delete A/B test
del
Get A/B test metrics
get
Get A/B test statistics
get
Attribute
Refreshes the cache for the specified attribute.
get
Get attributes
get
Get attribute
get
Delete attribute
del
Get attribute values
get
Get distinct attribute values
get
Get attribute usages
get
Suggestions
Get all autocomplete suggestions
get
Update autocomplete suggestion
put
Creates a new autocomplete suggestion
post
Get autocomplete suggestions
get
Delete autocomplete suggestion
del
Suggestions blacklisted terms
Get all blacklisted suggestions
get
Update a blacklisted suggestion
put
Create a blacklisted suggestion
post
Get a blacklisted suggestion
get
Delete a blacklisted suggestion
del
Category
Get category by key
get
Get category by ID
get
Delete category
del
Patch category
patch
Get all categories
get
Update category
put
Create category
post
Get Category tree. If called without parameters it will return root.
get
Get Category tree children
get
Lookup endpoint for categories
get
Get category path by id
get
Suggestions established terms
Get all established suggestions
get
Filter templates
Get filter template by id
get
Delete filter template
del
Get all filter templates
get
Update filter template
put
Create filter template
post
Get filter template attribute by id
get
Get all filter templates paginated
get
Delete filter template attribute
del
Get all filter template attributes
get
Update filter template attribute
put
Patch filter template attribute
patch
Create filter template attribute
post
Get filter template usages
get
Google analytics 4
Get link state
get
Remove link
get
Get metrics
get
Get dimensions
get
Get properties
get
Google analytics 4 reports
Get reports
get
Create report
post
Get report
get
Update report
put
Delete report
del
Preview report data
post
Include or exclude parameters
Get all hidden filters.
get
Add a new hidden filter.
post
Delete a hidden filter.
del
Instance
Get instance
get
Get the instance configuration
get
Update the instance configuration
put
Reporting & insights
Get report
get
Get report embed
get
Item
Get item
get
Delete item
del
Patch item
patch
Get all items
get
Update item
put
Create item
post
Get all item types
get
Get item usages
get
Instance statistics
Get total products
get
Get total categories
get
Get instance statistics
get
Language
Returns a list of all full text languages.
get
Returns a single language by its ID.
get
Deletes a language by its ID.
del
Returns a paginated list of all languages.
get
Updates an existing language.
put
Creates a new language.
post
Javascript
Get file content
get
Update file content
post
Initialize
post
Deploy
post
Get changes
get
Copy JS implementation from another instance
post
Suggestion manual terms
Get all manual suggestions
get
Update a manual suggestion
put
Create a manual suggestion
post
Get a manual suggestion
get
Delete a manual suggestion
del
Builder
Get builder
get
Delete a builder
del
Get all builders
get
Update builder
put
Creates a new builder
post
Get builder usages
get
Get available components
get
Get builder click rate
get
Personalization
Get profile data by key.
get
Builder authorizations
Get an authorization
get
Delete an authorization
del
Get all authorizations
get
Update an authorization
put
Create an authorization
post
Get authorization usages
get
Builder external data component
Get an external data component
get
Delete an external data component
del
Get all external data components
get
Update an external data component
put
Create an external data component
post
Get external data component usages
get
Get the performance of the external data component
get
Product
Get product
get
Delete product
del
Patch product
patch
Get all products
get
Update product
put
Create product
post
Recommendation
Get all featured recommendations
get
Get all product recommendation groupkeys
get
API attributes
Get all response data attributes.
get
Create a new response data attribute.
post
Delete a response data attribute.
del
Synonym
Get suggestions
get
Get all synonyms
get
Updates a synonym with the specified data, overrides all fields to the new value.
put
Create synonym
post
Get synonym for given id
get
Delete the synonym
del
Get the current state of the AI synonyms generation feature.
get
Update the state of the AI synonyms generation feature.
put
Task
Start task
get
Get task status
get
Tweakwise Analytics API
Events
/api/pageview
post
/api/purchase
post
/api/search
post
/api/itemclick
post
/api/sessionstart
post
/api/addtocart
post
/api/addtowishlist
post
/api/pageimpression
post
Introduction
Powered by
🧩 Commerce Platforms
Shopify
Multilingual installation
Ask AI
