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

paramdescription
querysearch query

Header

HeaderDescription
X-Correlation-IDA 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"
}

FieldDescriptionTypeExample Value
apikeyThe API key used for authenticationStringADB9E38C363A5AB7B17E34956D21543B
fieldThe field to search withinStringcontent
colThe collection IDs to search withinString1,2,3
typeThe type of search (e.g., phrase, keyword)Stringphrase
operatorThe logical operator for multiple terms (AND/OR)Stringor
limitThe maximum number of results to returnInteger20
termsThe number of terms to consider in the searchInteger5
queryThe search query termStringtest

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

FieldDescriptionTypeExample Value
apikeyThe API key used for authenticationStringADB9E38C363A5AB7B17E34956D21543B
colThe collection ID to search withinInteger1
limitThe maximum number of results to returnInteger12