Jump to Content
Status
Support
Guides
Recipes
Developers
Changelog
Roadmap
E-Learning
Status
Support
Tweakwise.com
Tweakwise App
Contact
Developers
Tweakwise.com
Tweakwise App
Contact
Moon (Dark Mode)
Sun (Light Mode)
Guides
Recipes
Developers
Changelog
Roadmap
E-Learning
Update A/B test
Search
JUMP TO
📝 Overview
Overview
Platforms
TLS Support
🎨 Integrations
Tweakwise API
Essentials
Search
Merchandising
Suggestions
Guided Selling
Recommendations
Items
Facets
Color swatches
Slider
Bucket slider
Search within filters
Sorting, ordering and paging
Language Support
How to
Override App Configuration
Use request parameters
Personalization & insights
Pass data to External Data provider
Tweakwise JS + Plugin Studio
Getting started
Configure Plugin Studio
Plugin configuration
Creating product tiles
Look & feel
Deploy
Copy configuration
Basic web app configuration
Search & Merchandising
Instant Search
Search + Suggestions
Merchandising
Google Analytics
Manual initialization
Language support
Options
Events
Defaults
Personalization
Suggestions
Options
Language support / translations
Migrating from instant search to suggestions
Category suggestion navigation
Recommendations
Options
Events
Guided Selling
Options
Events
Customize results
Measuring the Funnel
How to
Add to cart
Add to favorites / wishlist
Product Suggestions
Color swatches
Realtime pricing
Measure impressions using GA4
Use request parameters
Support common B2B scenarios
Override builder, sorting & filter templates
Pass data to External Data provider (JS)
Modify visual tile
Impact on SEO
Typescript
Known issues
Event Tag
Identification
Profiles
Server to server
Magento Platform
Magento 2 Open Source
Magento JS
Installation
Export data to Tweakwise
Consuming data from Tweakwise in Magento
Adobe Commerce
Magento 1 / OpenMage
Personalization
How to
Customize visual tiles
Customer specific catalog
Shopware
Installation
Export data to Tweakwise
Configure the Tweakwise feed with Shopware
Generate the Tweakwise feed with Shopware
Content of the feed
Consuming data from Tweakwise
Configure a new frontend
Configure your Shopware listing page
Recommendations in Shopware
Migrate your plugin from legacy Javascript to Plugin Studio
Available features
Vendre
Sana Commerce
Sana adoption matrix
Frontend 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
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
Backend API
Introduction
Authentication
AbTest
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
delete
Attribute
Refreshes the cache for the specified attribute.
get
Get attributes
get
Get attribute
get
Delete attribute
delete
Get attribute values
get
Get distinct attribute values
get
Get attribute usages
get
AutocompleteSuggestion
Get all autocomplete suggestions
get
Update autocomplete suggestion
put
Creates a new autocomplete suggestion
post
Get autocomplete suggestions
get
Delete autocomplete suggestion
delete
BlacklistedSuggestion
Get all blacklisted suggestions
get
Update a blacklisted suggestion
put
Create a blacklisted suggestion
post
Get a blacklisted suggestion
get
Delete a blacklisted suggestion
delete
Category
Get category by key
get
Get category by ID
get
Delete category
delete
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
EstablishedSuggestion
Get all established suggestions
get
Filter Templates
Get filter template by id
get
Delete filter template
delete
Get all filter templates
get
Update filter template
put
Create filter template
post
Get filter template attribute by id
get
Delete filter template attribute
delete
Get all filter template attributes
get
Update filter template attribute
put
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
delete
Preview report data
post
HiddenFilter
Get all hidden filters.
get
Add a new hidden filter.
post
Delete a hidden filter.
delete
Instance
Get instance
get
Get list of instances
get
Get the instance configuration
get
Update the instance configuration
put
Instance statistics
Get total products
get
Get total categories
get
Get instance statistics
get
Item
Get item
get
Delete item
delete
Patch item
patch
Get all items
get
Update item
put
Create item
post
Get all item types
get
Javascript
Get file content
get
Update file content
post
Initialize
post
Deploy
post
Get changes
get
Copy JS implementation from another instance
post
ManualSuggestion
Get all manual suggestions
get
Update a manual suggestion
put
Create a manual suggestion
post
Get a manual suggestion
get
Delete a manual suggestion
delete
Personalization
Get profile data by key.
get
Builder
Get builder
get
Delete a builder
delete
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
Builder Authorizations
Get an authorization
get
Delete an authorization
delete
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
delete
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
delete
Patch product
patch
Get all products
get
Update product
put
Create product
post
ResponseDataAttribute
Get all response data attributes.
get
Create a new response data attribute.
post
Delete a response data attribute.
delete
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
delete
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
Analytics API
Introduction
Events
Track item click
post
Track page view
post
Track purchase
post
Track search
post
Older integrations
Classic Tweakwise JS
Search & Merchandising
Installation
Product lister pages
Google Analytics
Options
Recommendations
Options
Guided Selling
Options
Suggestions
Migrating from instant search to autocomplete
Options
Common customizations
Custom styling
Add to cart
Add to favorites / wishlist
Color facet
VAT price switcher
Customize product suggestions
Impact on SEO
Powered by
Update A/B test
put
https://navigator-api.tweakwise.com/abtest
Language
Shell
Node
Ruby
PHP
Python
Credentials
Header +1
RESPONSE
Click
Try It!
to start a request and see the response here!
