Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.
Note

Important

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.

...

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.

Development

https://indexing-dev.hawksearch.net/

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

Test

https://indexing-test.hawksearch.net/

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

Production

https://indexingapi-na.hawksearch.com/

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

...

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

String

Contains the name of the index that is currently active.

Message

String

Will 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


Name

Data Type

Required

Description

Source or Admin Section

IndexName

String

Yes




...

Endpoint

Method

Header Key

api/v2/indexing/rebuild-related

POST

X-HawkSearch-ApiKey


Expand
titleParameters


Name

Data Type

Required

Description

Source or Admin Section

IndexName

String

Yes




...