Search Query API
The SearchBlox Collections API enables the user to get related queries and top queries from SearchBlox using simple HTTP POST and GET actions. SearchBlox Collection API provides methods to fetch related and top queries using REST requests with JSON payloads.
New Search API
Search API that is being used for the secure search. Users can also use the same to get JSON results for their search.
URL
https://localhost:8443/rest/v2/api/search?query=*&public=true
Method
GET
params
Below given are the basic mandatory parameters. There are a wide variety of parameters that are supported, please refer Search Parameters
param | description |
---|---|
query | search query |
Header
Header | Description |
---|---|
X-Correlation-ID | A unique identifier that can be sent through the search API request. The X-Correlation-IDs will be logged in ../webapps/ROOT/logs/query.log and can also be viewed in exported query logs file from SearchBlox Analytics. |
Returns
The JSON results from SearchBlox by default
Related Queries API
Index URL
https://localhost:8443/rest/v2/api/related/query
Method
POST
Media Type
application/json
Headers
content-type : application/json
accept: application/json
Headers
SB-PKEY
LmfxTTDSeYxHTntJMHuhwRrGVICMaVN/wl/zPuQ3LtQDNRMnng5GpKIkgt0q1rCC/h6wDA==
Document Syntax
{
"apikey":"ADB9E38C363A5AB7B17E34956D21543B",
"field":"content",
"col":"1,2,3",
"type":"phrase",
"operator":"or",
"limit":20,
"terms":5,
"query":"test"
}
Field | Description | Type | Example Value |
---|---|---|---|
apikey | The API key used for authentication | String | ADB9E38C363A5AB7B17E34956D21543B |
field | The field to search within | String | content |
col | The collection IDs to search within | String | 1,2,3 |
type | The type of search (e.g., phrase, keyword) | String | phrase |
operator | The logical operator for multiple terms (AND/OR) | String | or |
limit | The maximum number of results to return | Integer | 20 |
terms | The number of terms to consider in the search | Integer | 5 |
query | The search query term | String | test |
Top Queries API
Index URL
https://localhost:8443/rest/v2/api/query/top
Method
POST
Media Type
application/json
Headers
content-type : application/json
accept: application/json
Headers
SB-PKEY
LmfxTTDSeYxHTntJMHuhwRrGVICMaVN/wl/zPuQ3LtQDNRMnng5GpKIkgt0q1rCC/h6wDA==
Document Syntax
{
"apikey":"ADB9E38C363A5AB7B17E34956D21543B",
"col":1,
"limit":12
}
Document Description
Field | Description | Type | Example Value |
---|---|---|---|
apikey | The API key used for authentication | String | ADB9E38C363A5AB7B17E34956D21543B |
col | The collection ID to search within | Integer | 1 |
limit | The maximum number of results to return | Integer | 12 |
Updated 20 days ago