Search a Dataset

Guide to searching your Dataset with the API.

Search a data set

post

Search a data set with specified parameters

Authorizations

bearerAuth

AuthorizationstringRequired

Enter the token with the Bearer: prefix, e.g. "Bearer abcde12345".

Path parameters

data_set_idstringRequired

Data set token

Body

application/jsonapplication/x-www-form-urlencodedmultipart/form-data

search_querystringOptional

search_typestringOptional

search_chunk_limitintegerOptional

search_score_thresholdnumberOptional

Responses

200

Successful response

application/json

default

Error

application/json

post

/data_sets/{data_set_id}/search

HTTPcURLJavaScriptPython

POST /v1/data_sets/{data_set_id}/search HTTP/1.1
Host: api.fetchhive.com
Authorization: YOUR_API_KEY
Content-Type: application/json
Accept: */*
Content-Length: 94

{
  "search_query": "text",
  "search_type": "text",
  "search_chunk_limit": 1,
  "search_score_threshold": 1
}

application/jsonapplication/x-www-form-urlencodedmultipart/form-data

{
  "message": "Successfully ran a search on a data set.",
  "response": {}
}