For AI agents: the docs index is at https://docs.tweakwise.com/llms.txt. Append .md to any documentation page URL to get its markdown version.

Jump to Content

Guides Developers Changelog Roadmap E-Learning

v1.0

Status Support Tweakwise.com Tweakwise App Contact

Developers

Tweakwise.com Tweakwise App Contact

v1.0Guides Developers Changelog Roadmap E-Learning

📝 Overview

Overview
TLS Support

🎨 Integrations

Tweakwise API
Tweakwise JS

🧩 Commerce Platforms

Magento Platform
Shopify
Shopware
Sana Commerce
Vendre
- Vendre adoption matrix
Feature adoption

🗃️ Getting data in Tweakwise

Overview
Data Model
XML Feed
App API
- Batch Item Updates
Channable
How to

✨ Personalization

About
Profiles
GDPR for Personalization
How to use

🏷️ Event Tag

Event Tag Introduction
The base tag
The event tags
Tracking and Consent

Delivery API

Introduction
AiAssistant
- AI Shopping Assistant (standard navigation)post
- AI Shopping Assistant (grouped navigation)post
Autocomplete
- Autocompleteget
- Grouped autocompleteget
Catalog
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
Searchbanners
- searchbannersget
Starter
- Starterget
Suggestions

Tweakwise Backend API

Introduction
Authentication
A/B testing
Attribute
Suggestions
Suggestions blacklisted terms
Category
Suggestions established terms
- Get all established suggestionsget
Filter templates
Google analytics 4
Google analytics 4 reports
Include or exclude parameters
Reporting & insights
- Get reportget
- Get report embedget
Instance
Instance statistics
Item
Javascript
Language
Suggestion manual terms
Personalization
- Get profile data by key.get
Builder
Builder authorizations
Builder external data component
Product
Recommendation
- Get all featured recommendationsget
- Get all product recommendation groupkeysget
API attributes
Synonym
Task
- Start taskget
- Get task statusget

Tweakwise Analytics API

Events
Introduction

App API

A/B testing
Advanced settings
Analytics
- Returns personalization eventsget
API attributes
Attribute
BoostAndBury
Builder
Builder AI profile recommendations
- Returns AI recommendation availabilityget
Builder authorizations
Builder external data component
Category
Category landingpage
Category landingpage value
Changes
- Returns the unpublished changes per typeget
- Returns paged unpublished changes for a typeget
Filter templates
Google analytics 4
Google analytics 4 reports
GuidedSelling
Include or exclude parameters
Instance
- Returns instance configurationget
- Updates instance configurationput
Instance statistics
- Returns event tag validationsget
- Returns instance statisticsget
Item
Javascript
Language
Personalization
- Returns a personalization profileget
Pins
Product
Recommendation
Redirect
Reporting & insights
Search algorithm
SearchBanners
Sorting options
- Returns all sorting optionsget
- Returns a sorting optionget
Sorting templates
- Returns all sorting templatesget
- Returns a sorting templateget
Stoplist
Suggestions autocomplete
Suggestions blacklisted
Suggestions established terms
- Returns all established suggestionsget
Suggestions manual terms
Synonym
Tasks
- Returns task statusget
- Starts a taskget
Tweakwise.App.Api
- Returns API health statusget

Powered by

App API
SearchBanners

Deletes a search banner

delete

https://example.com/searchbanner/{searchBannerId}

Path Params

searchBannerId

int32

required

Headers

accept

string

enum

Defaults to application/json

Generated from available response content types

Allowed:

Responses

Updated about 1 hour ago

Returns a search banner

Sorting options

Did this page help you?

Language

Credentials

Loading…

Response

Click Try It! to start a request and see the response here!

Updated about 1 hour ago

Returns a search banner

Sorting options

Did this page help you?