SEMANTIC SEARCH
REQUEST BODY SCHEMA
application/json
Input POST body should be application/JSON (raw)
POST BODY
PARAMETER |
DESCRIPTION |
|||
url or text / keyword |
Type = String Full URL of the website to be analyzed and find related single URLs with similar and comparable content. Example: { |
|||
text or url / keyword |
Type = String Required! The text you want to be analyzed and find similar content. Use instead of "url" parameter (e.g. text=This is the text you want to be analyzed). {
|
|||
keywords or url / text |
Type = String The normalized keywords to search for entered as a comma separated string. Example: {
|
|||
|
||||
operator
|
Type = String Value: "and" (default: "or") The operator is used for keywords and surface_forms to explicitly connect the searched keywords with "and" or "or". Example: { Only search results with "Christilich Demokratische Union" AND "Angela Merkel" are shown. |
|||
|
SIMPLE SEARCH (FULL TEXT SEARCH)
REQUEST BODY SCHEMA
application/json
Input POST body should be application/JSON (raw)
POST BODY
PARAMETER |
DESCRIPTION |
|
surface_forms |
Type = String The surface form means full-text search. The occurrence of an entered string. Example: {
The search checks on which URL/TLD the input is occurring, and provides a related keyword cloud. |
|
FILTER
PARAMETER |
DESCRIPTION |
|||
safe Optional |
Type = String Default value ="False" Possible values: "False" and "True" By activating the safe search some brand safe categories like "adult, crime, death & injury, drugs, etc.
Example: { |
|||
lang Optional |
Type = String Required! Full URL of the website to be analyzed and find related single URLs with similar and comparable content. Possible values: "de" and "en" More on demand...
Example: { |
|||
tld Optional |
Type = String Filter by domain(s). If you're looking for specific Top Level Domains use this filter option. Examples: {
|
|||
category Optional |
Type = String Filter by hyscore category. A full list of categories you'll find here : #5.2 : Result and Response : Categories and IAB Example: { |
|||
iab Optional |
Type = String Filter by IAB category (v1) Tier 1 code. A full list of categories you'll find here: #5.2 : Result and Response : Categories and IAB Example (Auto) for IAB v1 and IAB v2 ### IAB v1 ### |
|||
maxresults Optional |
Type = Integer Maximum number of entries/results to be returned. Default value : "10" Maximum value: "10.000" Example: { |
|||
|
||||
EXCLUSION FILTER
With the exclusion filters, you can exclude keywords, categories (incl. IAB), top level domains (tld) and e.g. surface_forms keywords from search.
Example:
{"url":"http://www.spiegel.de", "maxresults":"10","category":"sport", "surface_forms":"Vettel", "lang":"de", "exclude":{"tld":"www.spiegel.de","surface_forms":"Hamilton"}}
Search for similar URLs / articles to "www.spiegel.de" with category "sport" and the surface_forms keyword "Vettel" in the German "de" language index, but exclude the www.spiegel.de (tld) and the keyword "Hamilton" (surface_forms).
You can combine the exclusion filters like in the example above.
PARAMETER |
DESCRIPTION |
||||
tld Optional |
Type = String Exclusion filter by domain(s). If you don't want to consider specific Top Level Domains use this filter option. Examples: { |
||||
category Optional |
Type = String Exclude filter of hyscore categories. A full list of categories you'll find here : #5.2 : Result and Response : Categories and IAB Example: { |
||||
iab Optional |
Type = String Exclude filter of IAB categories (v1/v2) Tier 1 code. A full list of categories you'll find here: #5.2 : Result and Response : Categories and IAB Example { |
||||
keywords Optional |
Type = String Exclude filter of keywords. Example: { |
||||
|
|||||
|
Comments
0 comments
Article is closed for comments.