logo
/documentation_
Search Preview API Reference
Initializing search
    • Home
    • Bizzkit
    • PIM
    • DAM
    • CMS
    • Ecommerce Search
    • Mail
    • Users
    • BAIA
    • Blueprint
    • Releases
    • Legal Notices
    • Home
    • Bizzkit
      • Showcasing Bizzkit
      • Bizzkit Academy
            • Getting started
            • Using DAM
            • Using PIM
            • Using CMS
            • Using ECS
            • Developing with DAM
            • Developing with PIM
            • Developing with ECS
            • Advisor training
            • Certified DAM user
            • Certified PIM user
            • Certified CMS user
            • Certified ECS user
            • Certified DAM developer
            • Certified PIM developer
            • Certified ECS developer
            • Certified Bizzkit Advisor
      • Bizzkit Support
      • Running Bizzkit in cloud
      • Development environments
      • Developing software at Bizzkit
      • Versioning strategy
      • Service Level Agreement
      • Definitions
      • Cookie Information
    • PIM
      • User guides
        • AI text generation
        • AI text translation
          • How to search and filter
          • How to edit data
          • How to use Mass Edit
          • How to add attributes
          • How to use dashboards
          • How to work with hierarchies
          • How to import products
          • How to replace DAM files
          • Naming conventions
          • Setting up an attribute
          • Working with multiple PIM environments
      • Concepts
        • Features
          • AI assisted functionality
            • AI text generation with BAIA
            • AI translation with BAIA
            • AI suggested values for global lists
            • AI product placement suggestions with BAIA
            • BAIA Configuration
          • Dashboards
          • Search and filters
            • Product search bar
            • Product filters
            • Basic filters
            • Advanced filters
            • Quick filters
            • Filter operators
          • Mass edit
          • Bulk operations
            • Job overview
            • Attribute value history
            • Product enrichers
            • Product validators
            • Drag & drop file upload
          • Products
            • Master/variant hierarchies
            • Bundles
          • Attributes
            • Calculated attributes
            • Attribute groups
            • PString-based types display configuration
          • Product hierarchies
          • Data types
          • Segmentations
          • Resolved views
          • Roles and permissions
          • User preferences
        • Solution architecture
      • For developers
          • Configuring product placement suggestions
          • Modelling attributes
          • PIM API Reference
          • PIM Preview API Reference
          • CSV specification
          • CSV Examples
          • JSON Import API Reference
          • Resolved views structural versions
          • External bulk operations
            • Creating external bulk operations
            • Setting up the customer solution
            • Securing external bulk operations
          • Webhooks
      • FAQ
    • DAM
      • User guides
        • Permissions management
        • Cropping an image
        • Chooser mode: Selecting files
          • Creating a content language
          • Creating a transformation function
          • Creating a resource image
          • Creating an aspect ratio
          • Creating an attribute category
          • Creating an attribute or tag
        • Creating translations
        • File and folder management
          • Setting folder permissions
        • Organize
      • Concepts
        • Attributes and tags
        • Basket
        • Files
        • Folders
        • Image descriptions
        • Permission management
        • Translations
      • For developers
        • Getting started
          • Cdn records
          • Events
          • File picking
          • Integration points
          • Transformation functions
            • Examples
            • Implement a file chooser
            • Restrict which filetypes can be selected when in chooser mode
        • References
          • DAM API Reference
          • DAM Preview API Reference
    • CMS
      • Concepts
        • Bizzkit plugins
        • Bizzkit components
        • Bizzkit content hub
      • For developers
        • Bizzkit single sign on
        • Bizzkit plugins
        • Bizzkit starter kit
        • Environments
        • SDK
    • Ecommerce Search
      • Getting started
        • Integration Development Checklist
        • Improving Search Results
      • User guides
          • Best practices for searching Bizzkit CMS Classic content
          • Commercial Sorting Best practices
          • Product assortment best practices
        • Dashboard
          • Findability
          • Allowed filters
          • Allowed sortings
          • Experience tags
          • Facets
          • Search relevance
        • Playground
          • Experience
          • Business Rules & Inheritance
          • Effects
          • Playground links
          • Hypernyms
          • Misspellings
          • Searchable fields
          • Stemming Overrides
          • Synonyms
          • Related tag groupings
          • Suggestion Candidates
      • Concepts
        • Business rules
        • Commercial sorting
          • Commercial Parameters
          • Normalization
          • Personalization
        • Content
          • Field name priority
          • Content Limitation
        • Dashboards
          • Overall Performance
          • Popular searches
          • Findability
          • No product results
          • Search Response Time
          • Full search
          • Quick search
          • Browse search
          • Search tracking
        • Diagnostics
          • Pipeline analysis
        • Experiences
        • Ingestion
          • Commercial parameters
          • Content
          • Products
          • Suggestion Candidates
        • Popular searches
          • Pricing strategies
        • Products
          • Product Families
          • Field name priority
          • SKUs
        • Publications
        • Scopes
        • Searching
          • Unified Search
          • Redirects
          • Filters
          • Sorting
          • Did You Mean
          • Searchable images
          • Semantic search
          • Authenticated Search
          • Export
        • Segments
          • Allowed filters
          • Allowed sortings
        • Suggestions
          • Taboos
          • Suggestion Generator Rules
          • Related tags
          • AI Related Tags
        • Targets
        • Text analysis
          • Dictionaries
          • Hypernyms
          • Ignored Words
          • Irregular Words
          • Misspellings
          • Multi-Words
          • Stemming Overrides
          • Stemming
          • Synonyms
      • For developers
        • Limits
          • Rate limiting
          • Common pitfalls
          • Api
            • Admin API Reference
            • Admin Preview API Reference
            • Courier API Reference
            • Courier Preview API Reference
            • Search API Reference
            • Search Preview API Reference
          • Bizzkit cms integration
          • Bizzkit pim integration
            • User Affinities in practice
            • Planning price changes
          • Searching
            • Search Client
            • Handling Redirects
            • Authenticated Search
            • Traffic Filtering
            • Debug Information in Searching
          • Configuring CORS
          • Configuring Google Analytics
            • Common parameter configuration options
        • FAQ
    • Mail
      • Getting started
      • Concepts
        • Mails
        • Mail policies
        • Mail providers
        • Jobs
      • For developers
          • Best practices
          • Mail API Reference
          • Mail Preview API Reference
    • Users
      • User guides
        • Create users and roles
        • Local login
        • Email templates
        • User metadata
        • Login page styles
        • Manage MFA
        • Forget password
      • Concepts
        • Downstream clients
      • For developers
        • Getting started
          • Migrating users installation
          • Api
      • FAQ
    • BAIA
        • Getting started
          • How to create a recipe
          • How to manage a recipe
              • Create and populate global list
              • Create transformation function
              • List transformation functions
              • Check for synonyms
              • Validate synonyms
              • Validate hypernyms
              • Validate irregular words
              • Copy context
              • List users in role
      • Concepts
      • For developers
        • Custom functions (preview)
        • Semantic functions (preview)
        • BAIA API
        • BAIA Preview Api
        • Bizzkit MCP server
    • Blueprint
          • Install Bizzkit Blueprint
          • Setup new solution
          • Introduction to the code
        • Fundamentals
          • Basket
          • Configuration
          • Order
          • Price
          • Product
          • Routing
          • Segmentation
          • Stock
          • WebsiteUser
          • BUM integration
          • DAM integration
          • CMS integration
          • PIM integration
          • Mail integration
          • Search integration
          • Cache usage
        • Extensions
          • Payment
            • Getting started
              • Installing the Payment-extension
              • Listing payment options
              • Creating payments
              • Setting up the server callback handling
            • Integrations
              • AltaPay
              • Bambora
              • Billwerk+
              • EAN
              • ePay
              • Invoice
              • Netaxept
              • Zero
          • Blueprint 2024.4.1
          • Blueprint 2024.5.0
        • API Reference
        • Blueprint Storybook
      • Release notes
          • BAIA 25.3
          • BAIA 25.2
          • BAIA 25.1
          • BAIA 25.0
          • BAIA 24.10
          • BAIA 24.9
          • BAIA 24.8
          • BAIA 24.7
          • BAIA 24.6
          • BAIA 24.5
          • BAIA 24.4
          • BAIA 24.3
          • BAIA 24.2
          • BAIA 24.1
          • BAIA 24.0
          • PIM 26.0 (Draft)
          • PIM 25.36
          • PIM 25.35
          • PIM 25.34
          • PIM 25.33
          • PIM 25.32
          • PIM 25.31
          • PIM 25.29
          • PIM 25.28
          • PIM 25.27
          • PIM 25.26
          • PIM 25.25
          • PIM 25.24
          • PIM 25.23
          • PIM 25.22
          • PIM 25.21
          • PIM 25.20
          • PIM 25.19
          • PIM 25.18
          • PIM 25.17
          • PIM 25.16
          • PIM 25.15
          • PIM 25.14
          • PIM 25.13
          • PIM 25.12
          • PIM 25.11
          • PIM 25.10
          • PIM 25.9
          • PIM 25.8
          • PIM 25.7
          • PIM 25.6
          • PIM 25.5
          • PIM 25.4
          • PIM 25.3
          • PIM 25.2
          • PIM 25.1
          • PIM 25.0
          • PIM 24.26
          • PIM 24.25
          • PIM 24.24
          • PIM 24.23
          • PIM 24.22
          • PIM 24.21
          • PIM 24.20
          • PIM 24.18
          • PIM 24.17
          • PIM 24.16
          • PIM 24.15
          • PIM 24.14
          • PIM 24.13
          • PIM 24.12
          • PIM 24.11
          • PIM 24.10
          • PIM 24.9
          • PIM 24.8
          • PIM 24.7
          • PIM 24.6
          • PIM 24.5
          • PIM 24.4
          • PIM 24.3
          • PIM 24.2
          • PIM 24.1
          • PIM 24.0
          • DAM 25.8
          • DAM 25.7
          • DAM 25.6
          • DAM 25.5
          • DAM 25.4
          • DAM 25.3
          • DAM 25.2
          • DAM 25.1
          • DAM 25.0
          • DAM 24.10
          • DAM 24.8
          • DAM 24.7
          • DAM 24.6
          • DAM 24.5
          • DAM 24.4
          • DAM 24.3
          • DAM 24.2
          • DAM 24.1
          • DAM 24.0
          • CMS 25.1
          • CMS 25.0
          • CMS 24.4
          • CMS 24.3
          • CMS 24.2
          • CMS 24.1
          • CMS 24.0
          • Ecommerce Search 26.0
          • Ecommerce Search 25.20
          • Ecommerce Search 25.19
          • Ecommerce Search 25.18
          • Ecommerce Search 25.17
          • Ecommerce Search 25.16
          • Ecommerce Search 25.15
          • Ecommerce Search 25.14
          • Ecommerce Search 25.13
          • Ecommerce Search 25.12
          • Ecommerce Search 25.11
          • Ecommerce Search 25.10
          • Ecommerce Search 25.9
          • Ecommerce Search 25.8
          • Ecommerce Search 25.7
          • Ecommerce Search 25.6
          • Ecommerce Search 25.5
          • Ecommerce Search 25.4
          • Ecommerce Search 25.3
          • Ecommerce Search 25.2
          • Ecommerce Search 25.1
          • Ecommerce Search 25.0
          • Ecommerce Search 24.48
          • Ecommerce Search 24.47
          • Ecommerce Search 24.46
          • Ecommerce Search 24.45.0
          • Ecommerce Search 24.44
          • Ecommerce Search 24.43
          • Ecommerce Search 24.42
          • Ecommerce Search 24.41
          • Ecommerce Search 24.40
          • Ecommerce Search 24.39
          • Ecommerce Search 24.38
          • Ecommerce Search 24.37
          • Ecommerce Search 24.36
          • Ecommerce Search 24.35
          • Ecommerce Search 24.34
          • Ecommerce Search 24.33
          • Ecommerce Search 24.32
          • Ecommerce Search 24.31
          • Ecommerce Search 24.30
          • Ecommerce Search 24.29
          • Ecommerce Search 24.28
          • Ecommerce Search 24.27
          • Ecommerce Search 24.26
          • Ecommerce Search 24.25
          • Ecommerce Search 24.24
          • Ecommerce Search 24.23
          • Ecommerce Search 24.22
          • Ecommerce Search 24.21
          • Ecommerce Search 24.20
          • Ecommerce Search 24.19
          • Ecommerce Search 24.18
          • Ecommerce Search 24.17
          • Ecommerce Search 24.16
          • Ecommerce Search 24.15
          • Ecommerce Search 24.14
          • Ecommerce Search 24.13
          • Ecommerce Search 24.12
          • Ecommerce Search 24.11
          • Ecommerce Search 24.10
          • Ecommerce Search 24.9
          • Ecommerce Search 24.8
          • Ecommerce Search 24.7
          • Ecommerce Search 24.6
          • Ecommerce Search 24.5
          • Ecommerce Search 24.4
          • Ecommerce Search 24.3
          • Ecommerce Search 24.2
          • Ecommerce Search 24.1
          • Ecommerce Search 24.0
          • Mail 26.0 (Draft)
          • Mail 25.0
          • Mail 24.5
          • Mail 24.4
          • Mail 24.3
          • Mail 24.1
          • Mail 24.0
          • User Management 25.2
          • User Management 25.1
          • User Management 25.0
          • User Management 24.1
          • Users 24.0
          • CMS 25.0
          • CMS 24.3
          • CMS 24.2
          • CMS 24.1
          • CMS 24.0
      • Archive
        • 26. March 2025
        • 12. March 2025
        • 05. March 2025
        • 28. February 2025
        • 23 January 2025
        • 15 January 2025
        • 07 January 2025
        • 20 December 2024
        • 1 November 2024
        • 11 October 2024
        • 3 September 2024
        • 7 August 2024
        • 18 July 2024
        • 5 June 2024
        • 27 March 2024
      • Site updates
    • Legal Notices
    api developer search

    Search Preview API Reference

    You can learn more about the API structure in Search Preview API Explorer.