KOkokocares

Match against regexes

This endpoint allows for testing whether individual search queries would match against the keyword list. This is for testing purposes only and should not be used in a production environment.

get/keywords/match

Request

  • Base URL
    http://api.kokocares.org
  • URL
    http://api.kokocares.org/keywords/match
  • Auth
    HTTP basic

Query parameters

querystring required

The search query to be matched against the keywords

filterstring

Filter the keyword based on the taxonomy using a colon delimited list of “dimension=value” filters. Omitting a dimension does not filter by that dimension e.g. category=eating,parenting:confidence=1,2

This returns a regex with keywords for eating and parenting, with a confidence of 1 and 2 and any intensity.

Ommitting the param entirely returns a regex for all keywords

versionstring

The version to query against otherwise the query will be against the latest version.

Headers

X-API-VERSIONstring

When backwards incompatible changes are made to the API, the api version is changed. The latest api version will be pinned to your API key, so you only need to add this header if you want to use a more up to date version. You can also update the pinned version by contacting us at api@kokocares.org.

Response

search results matching criteria

filterstring required
querystring required
matchboolean required
versionstring required

Example response

{
  "filter": "category=eating,parenting:confidence=1,2",
  "query": "seeewerslllide",
  "match": true,
  "version": "20220206"
}

Changes

No recorded changes to this operation across all 1 revision of this API.