Eureka Suggestion API

Overview

The Suggestion API offers query recommendations as users type into a search bar. It analyzes the input text and returns a list of relevant suggestions in real-time, based on user history, and other contextual information like category and brand. This feature notably improves the user experience, accelerating the search process and effectively directing users to their intended queries.

Endpoint 

You can use two domains to use the Suggestion API:

• eureka.api.useinsider.com
• ineureka.api.useinsider.com

GET https://{domain_name}/api/web/suggestions

When the request is sent in this way, an authentication exception is thrown for security reasons. Therefore, when sending the request, you need to set the X-AUTH-TOKEN field in the header with the token shared with you and send the request.

Request Parameters

Sample Responses

API Responses

200 Search

{ 
  "status": "Success",
  "data": [
    {
      "phrase": "..."
      "phraseType": "..."
    }, ...
  ],
  "error": null,
  "validations": null
}

500 Internal Server Error

{ 
  "status": "Error",
  "data": null,
  "redirection": null,
  "partnerResources": null,
  "error": {
    "code": "500 INTERNAL_SERVER_ERROR",
    "message": "..." 
  },
  "validations": null,
  "appliedSearchStrategy": null 
}

400 Validation Exception

{
  "status": "ValidationException",
  "data": null,
  "error": null,
  "validations": [
    "..."
  ]
}

Fail Records Messages

• Business Exceptions

• Validation Exceptions