Jump to Content
HawkSearch DocsHawkSearch WebsiteHawkSearch DashboardHawkSearch User Guide
HomeGuidesAPI Reference
v1.0

HawkSearch WebsiteHawkSearch DashboardHawkSearch User GuideLog InHawkSearch Docs
Guides
Log In
v1.0HomeGuidesAPI Reference

Overview

  • What is HawkSearch?
  • Best Practices
    • Project Planning
    • Working with HawkSearch
    • Deployment
    • Developer Best Practices
  • Getting Started
    • Environments and Endpoints
    • HawkSearch Status Page
    • Your Data
    • Scraping Unstructured Content
    • Indexing Your Data
    • Front End Development
    • Importing Order Data
    • Event Tracking
    • Troubleshooting
    • Using Data Feed Files
    • E360 Setup - Advanced Analytics

Hawk v4.0 API (Elastic)

  • Overview
  • Hierarchy API
  • Indexing API
    • Bulk Operations Indexing API
    • Full v/s Partial Indexing
  • Mapping API
  • Search API
    • Concept Search
    • Visual Search
    • Unified/Hybrid Search
    • Did you mean Search
    • Field-specific Search
    • Field-Specific Search - V2
    • Dynamic Query Boost Search
    • No Results Search
    • Search Within
    • Front-end facets response
    • Facet and Field Types
  • Autocomplete API
    • Did You Mean? in Autocomplete
    • Instant Engage
  • Hawksearch 4.0 Variants
  • Dashboard API
    • Managing Fields
    • Managing Facets
    • Rebuild Indexes
    • Managing Banners
    • Managing Boost and Bury Rules
    • Managing Landing Pages
    • Managing Landing Page Layout
    • Managing Pagination
    • Managing Recommendation Widgets
    • Managing Recommendation Visibility Rules
    • Managing Visitor Target
    • Managing Reports
    • Managing Sorting Sets
    • Managing Merchandising Sections
    • Managing Keyword Search Section
    • Managing AI Multiplier
    • Rule XML
  • Recommendation API
  • Event Tracking API
  • API for Creating a Facet
  • Response customization by hiding
  • Postman Collection

api Objects

  • Object Overview
  • Field Object
  • Facet Object
  • Banner Object
  • Boost Bury Object
  • Campaign Object
  • Indexing Object
  • Landing Page Object
  • Rule XML Object
  • Pagination Object
  • Sorting Object
  • Merchandising Object
  • Keyword Searching Object
  • Recommendation Object

Smart Search

  • Overview
  • Concept Search Implementation Guide
  • Visual Search & Image Search Implementation Guide
  • Unified/Hybrid Search Implementation Guide

CONNECTORS

  • Overview
    • Recommendations
    • Landing Pages
    • Tracking Implementation
    • Syncing of Attributes between system and Hawksearch
    • Product Compare
  • BigCommerce
    • App Overview
    • Vue.js SDK
    • Rapid UI Framework
    • Event Tracking Code
    • Release Notes
  • Kentico
    • Supported Kentico Version
    • For Administrators
    • For Users
    • For Developers
    • Release Notes
  • Optimizely (B2B) Configured Commerce - XConnect
    • Supported Optimizely Versions
    • Supported HawkSearch Features
    • Installing the Package
    • Preparing Products & Attributes for Indexing
    • Indexing to HawkSearch
    • Fields & Facets in HawkSearch
    • Mapping Fields in HawkSearch for Preview & Autocomplete
    • Customizations
    • Troubleshooting
    • Toggle Settings
    • Landing Page Setup
    • Tracking Setup
    • Licensing​
    • Recommendation Configuration
    • Instant Engage
  • Optimizely B2C
    • Installation
    • Configuration
    • HawkSearch Field Setup
    • Indexing
    • Default Handlers & Pipes
    • Extensions
    • Search
    • Front End Details
  • Salesforce
    • Overview
    • Installation
    • Basic Configuration
    • Indexing Configuration
    • Customizations
    • UI Components
    • Troubleshooting
  • Sitefinity
    • Supported Sitefinity Version
    • Installation and Setup
    • Sitefinity Configuration
    • Connector Configuration
    • Front End Development
    • Developer Examples
    • Developer Examples (Cont)
    • Known Issues
    • Managing Indexes
      • Managing V4 Indexes
      • Managing V4L Indexes
    • Working with HawkSearch Widgets
      • Configuring HawkSearch Box Widget
      • Configuring Hawksearch Results Widget
  • Magento
    • Getting Started
    • Domains and Environments
    • Message Queues
    • Troubleshoot indexing process
    • Magento LL 2.x
    • Customize
      • Front-end Customization
      • Add custom indexing entity
    • Search Tuning
    • Developers
      • Backward compatibility policy
    • Indexing

hawksearch sdks

  • SDK Overview
  • React SDK
    • React SDK setup
    • Create results widget
    • Extending result item component
    • React Components
  • VUE SDK
    • Requirements and setup
    • Configuration Options
    • Advanced Configuration
    • Creating widgets with Vue SDK
    • Development reference: List of Vue.js components
    • Vue SDK Release Notes
  • .NET SDK
    • Installing SDK
    • HawksearchClient
    • Indexing operations
    • Searching operations
    • Working with Export API

RAPID UI FRAMEWORK

  • Rapid UI Overview
  • Rapid UI Docs
  • Rapid UI Basics
    • Default Initial Values
    • Event Listeners
    • Recommendations
  • Rapid UI Overrides
  • Rapid UI Tracking
  • Rapid UI Examples
  • Rapid UI Configuration
    • Migrating to v6
    • Instant Engage
    • Scrolling Placeholder in Search Bar
  • Rapid UI Release Notes
    • Conversational Search and Smart Response

Quickstart

  • Getting Started
  • HawkSearch Dev Account
  • Create Fields in HawkSearch
  • Create Your Facets
  • Import Data File
  • Index the Data
  • Sample Page Using Rapid UI
  • Play in your sandbox
    • How To Reindex
    • Boost and Bury
    • Start a Campaign
    • Understanding Changes to Your HawkSearch Index: What to Do Next
    • How to add Smart Search to QuickStart Sandbox
    • How to Use & Change Rapid UI Template
    • Synonyms
    • How to use Item Pinning
    • Working with the AI Multiplier
    • Setting Up Measurement Conversion
    • Setting Up Recommendations
Powered by 

Overview

Suggest Edits

This information is for older versions of Hawksearch and NOT the latest v4.0. This is not compatible with the Search Api or Indexing Api. Please contact Hawksearch for more information

  • JavaScript Integration
  • Event Tracking Code
  • API - front end integration
  • Proxy/Hybrid Integration

Updated about 2 months ago