For AI agents: visit https://docs.tweakwise.com/llms.txt for an index of all pages formatted in Markdown and endpoints in OpenAPI.
Jump to Content
TweakwiseStatusSupport
GuidesDevelopersChangelogRoadmapE-Learning
StatusSupportTweakwise.comTweakwise AppContactTweakwise
Developers
Tweakwise.comTweakwise AppContact
GuidesDevelopersChangelogRoadmapE-Learning

📝 Overview

  • Overview
  • TLS Support

🎨 Integrations

  • Tweakwise API
    • Essentials
    • Search
    • Suggestions
      • Search phrase suggestions
      • Item suggestions
      • 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
      • Handle Customer Specific Pricing
      • Handle Customer Specific Catalogs
  • 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
      • Landing 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
      • How to - Add custom facet URLs
      • Displaying Custom Badges for Tweakwise Builder Components
      • Integrating Native DOM Elements into Tweakwise JS
      • Implementing Popular Searches & Categories
      • Handle Customer Specific Pricing
      • Handle Customer Specific Catalogs
    • 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
      • Enable A/B Testing support
      • Identify requests as internal traffic
      • Sync feed generation & import jobs
      • Implementing Flexible Sized Grid Items in Magento 2 with Hyvä
      • Implementing Flexible Sized Grid Items in Magento 2 with Luma
      • Add support for Shared Catalogs
    • Frequently Asked Questions
      • A/B Test is not working
      • 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
    • Magento x Tweakwise Agentic Development
      • Magento x Tweakwise - Prompt
  • 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
  • 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
    • Attribute Landing 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
    • Autocompleteget
    • Grouped autocompleteget
  • Catalog
    • Filter templatesget
    • Sorting templatesget
    • Buildersget
    • Featured recommendationsget
    • Product recommendationsget
    • Product recommendations groupsget
    • Guided Selling setupsget
    • Languagesget
  • Category tree
    • Category treeget
  • Facets
    • Facetsget
    • Facet attributesget
  • Feed
    • Feedget
  • Guided selling
    • Compareget
    • Funnelget
  • Instance
    • Instanceget
  • Navigation
    • Navigationget
    • Grouped navigationget
  • Navigation search
    • Searchget
    • Grouped searchget
  • Products
    • Productsget
    • Productget
  • Redirects
    • Redirectsget
  • Recommendations
    • Product recommendationsget
    • Product recommendations single ruleget
    • Product recommendations multi ruleget
    • Featured productsget
    • Optional parameters
  • Searchbanners
    • searchbannersget
  • Suggestions
    • Suggestionsget
    • Suggestions groupedget
    • Suggestion productsget
    • Suggestion products groupedget
    • Suggestion itemsget
    • Suggestion items groupedget

Tweakwise Backend API

  • Introduction
    • Authentication
  • A/B testing
    • Get all A/B testsget
    • Update A/B testput
    • Create a new A/B testpost
    • Get A/B testget
    • Delete A/B testdel
    • Get A/B test metricsget
    • Get A/B test statisticsget
  • Attribute
    • Refreshes the cache for the specified attribute.get
    • Get attributesget
    • Get attributeget
    • Delete attributedel
    • Get attribute valuesget
    • Get distinct attribute valuesget
    • Get attribute usagesget
  • Suggestions
    • Get all autocomplete suggestionsget
    • Update autocomplete suggestionput
    • Creates a new autocomplete suggestionpost
    • Get autocomplete suggestionsget
    • Delete autocomplete suggestiondel
  • Suggestions blacklisted terms
    • Get all blacklisted suggestionsget
    • Update a blacklisted suggestionput
    • Create a blacklisted suggestionpost
    • Get a blacklisted suggestionget
    • Delete a blacklisted suggestiondel
  • Category
    • Get category by keyget
    • Get category by IDget
    • Delete categorydel
    • Patch categorypatch
    • Get all categoriesget
    • Update categoryput
    • Create categorypost
    • Get Category tree. If called without parameters it will return root.get
    • Get Category tree childrenget
    • Lookup endpoint for categoriesget
    • Get category path by idget
  • Suggestions established terms
    • Get all established suggestionsget
  • Filter templates
    • Get filter template by idget
    • Delete filter templatedel
    • Get all filter templatesget
    • Update filter templateput
    • Create filter templatepost
    • Get filter template attribute by idget
    • Get all filter templates paginatedget
    • Delete filter template attributedel
    • Get all filter template attributesget
    • Update filter template attributeput
    • Patch filter template attributepatch
    • Create filter template attributepost
    • Get filter template usagesget
  • Google analytics 4
    • Get link stateget
    • Remove linkget
    • Get metricsget
    • Get dimensionsget
    • Get propertiesget
  • Google analytics 4 reports
    • Get reportsget
    • Create reportpost
    • Get reportget
    • Update reportput
    • Delete reportdel
    • Preview report datapost
  • Include or exclude parameters
    • Get all hidden filters.get
    • Add a new hidden filter.post
    • Delete a hidden filter.del
  • Reporting & insights
    • Get reportget
    • Get report embedget
  • Instance
    • Get instanceget
    • Get the instance configurationget
    • Update the instance configurationput
  • Instance statistics
    • Get total productsget
    • Get total categoriesget
    • Get instance statisticsget
  • Item
    • Get itemget
    • Delete itemdel
    • Patch itempatch
    • Get all itemsget
    • Update itemput
    • Create itempost
    • Get all item typesget
    • Get item usagesget
  • Javascript
    • Get file contentget
    • Update file contentpost
    • Initializepost
    • Deploypost
    • Get changesget
    • Copy JS implementation from another instancepost
  • 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
  • Suggestion manual terms
    • Get all manual suggestionsget
    • Update a manual suggestionput
    • Create a manual suggestionpost
    • Get a manual suggestionget
    • Delete a manual suggestiondel
  • Personalization
    • Get profile data by key.get
  • Builder
    • Get builderget
    • Delete a builderdel
    • Get all buildersget
    • Update builderput
    • Creates a new builderpost
    • Get builder usagesget
    • Get available componentsget
    • Get builder click rateget
  • Builder authorizations
    • Get an authorizationget
    • Delete an authorizationdel
    • Get all authorizationsget
    • Update an authorizationput
    • Create an authorizationpost
    • Get authorization usagesget
  • Builder external data component
    • Get an external data componentget
    • Delete an external data componentdel
    • Get all external data componentsget
    • Update an external data componentput
    • Create an external data componentpost
    • Get external data component usagesget
    • Get the performance of the external data componentget
  • Product
    • Get productget
    • Delete productdel
    • Patch productpatch
    • Get all productsget
    • Update productput
    • Create productpost
  • Recommendation
    • Get all featured recommendationsget
    • Get all product recommendation groupkeysget
  • API attributes
    • Get all response data attributes.get
    • Create a new response data attribute.post
    • Delete a response data attribute.del
  • Synonym
    • Get suggestionsget
    • Get all synonymsget
    • Updates a synonym with the specified data, overrides all fields to the new value.put
    • Create synonympost
    • Get synonym for given idget
    • Delete the synonymdel
    • Get the current state of the AI synonyms generation feature.get
    • Update the state of the AI synonyms generation feature.put
  • Task
    • Start taskget
    • Get task statusget

Tweakwise Analytics API

  • Events
    • /api/pageviewpost
    • /api/purchasepost
    • /api/searchpost
    • /api/itemclickpost
    • /api/sessionstartpost
    • /api/addtocartpost
    • /api/addtowishlistpost
    • /api/pageimpressionpost
  • Introduction
Powered by 
  1. 🧩 Commerce Platforms
  2. Magento Platform
  3. Frequently Asked Questions

How to add canonical URLs?

This is not part of Tweakwise but of Magento. Read How to Add Canonical URLs in Magento 2? to learn more.

Updated 6 months ago


How are article numbers determined?
Which stock is uploaded for configurable products?
Did this page help you?

Updated 6 months ago


How are article numbers determined?
Which stock is uploaded for configurable products?
Did this page help you?