Search Terminology

curl -G https://api.markup.ai/brand-terms/search \
     -H "Authorization: Bearer <token>" \
     -H "Content-Type: application/json" \
     -d domain_ids=health-and-fitness \
     -d domain_ids=eco-friendly-products \
     --data-urlencode "query=Introducing the new EcoSmart water bottle with advanced insulation technology"

{
  "results": [
    {
      "context": "Introducing the new EcoSmart water bottle with advanced insulation technology",
      "terms": [
        {
          "term": "EcoSmart water bottle",
          "type": "product_name",
          "case_sensitive": true
        },
        {
          "term": "advanced insulation technology",
          "type": "feature",
          "case_sensitive": false
        }
      ],
      "matched_terms": [
        {
          "term": "EcoSmart water bottle",
          "matched_ngram": "EcoSmart water bottle"
        },
        {
          "term": "advanced insulation technology",
          "matched_ngram": "advanced insulation technology"
        }
      ],
      "context_polarity": "positive"
    }
  ]
}

Searches the text for relevant terminology and returns matched term sets.

Term sets are matched if any word sequence (up to 5 words) in the text is similar to one of the terms of the term set. The similarity measure used is a trigram similarity of 0.5 or higher between the word sequence and the term.

Authentication

AuthorizationBearer

Bearer authentication of the form Bearer <token>, where token is your auth token.

Query parameters

querystringRequired

domain_idslist of strings or nullOptional

Optional domain filter

Response

Successful Response

resultslist of objects

Errors

401

Unauthorized Error

403

Forbidden Error

422

Unprocessable Entity Error

500

Internal Server Error