Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.
Comment: Version published after converting to the new editor


Section


Column
width70%


Info
titleImportant

Depending on the version of HawkSearch used, method of integration, and the presence of data feed files for indexing, you may need to perform indexing as per this article or Using Dashboard API to Rebuild Indexes. Please contact HawkSearch for any clarifications.

Domains

Hawksearch has three environments available: Development, Test and a load-balanced Production.  When using the search API methods in this document, the following domains can be used to access each environment after your engine has been set-up in that environment.

Note: to index hierarchical data, please build the hierarchy using the Hierarchy API and then call the index-items API.

Development

indexing-dev.hawksearch.net/

Configurations for an engine in this location are maintained in the Hawksearch Workbench at dev.hawksearch.net.

Test

indexing-test.hawksearch.net/

Configurations for an engine in this location are maintained in the Hawksearch Workbench at test.hawksearch.net.

Production

indexingapi-na.hawksearch.com

Configurations for an engine in this location are maintained in the Hawksearch Workbench at https://dashboard-na.hawksearch.com/



Column
width30%

Contents

Table of Contents
maxLevel2


...

Expand
titleExamples

Example 2.1

Delete single item from index

{
    "IndexName": "myengine.20200123.153931",

         "Id": "Item_DocId"
}


Response

Expand
titleStructure

None or Message with Error

Object

Data Type

Description

IndexNames

Array of strings

Each string contains the names of the indexes that exist in the engine.  The most recently created will be listed first.

IndexName

StringContains the name of the index that is currently active.
MessageStringWill return error message in case if occurs


...

Expand
titleExamples

Example 3.1

Delete single item from index

{
    "IndexName": "myengine.20200123.153931",

         "Ids": ["Item_DocId", "Item_Doc2Id"]
}


Response

Expand
titleStructure

None or Message with Error

Object

Data Type

Description

None or Message with Error




...

Endpoint

Method

Header Key

api/v2/indexing/rebuild-learning

POST

X-HawkSearch-ApiKey


Expand
titleParameters


NameData TypeRequiredDescriptionSource or Admin Section

IndexName

String

Yes




...

Endpoint

Method

Header Key

api/v2/indexing/rebuild-related

POST

X-HawkSearch-ApiKey


Expand
titleParameters


NameData TypeRequiredDescriptionSource or Admin Section

IndexName

String

Yes




...