Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

...

Method description

Get a list of blacklists boosts for this the requested instance filtering by keywords. The list is paginated.

Security

The calling user must have the EB_ROOT, EB_ADMIN, EB_APP, SEARCH_ADMIN, SEARCH_MANAGER or SEARCH_ANALYST role for this instance or the global instance.

Parameters

URI Parameters

Parameter Name

Required

Description

keywords(tick)Filter by this keywords

Response format and codes

HTTP code

Description

200OK. Response follows
400Invalid parameters. Error response will include details
401The user does not meet the security criteria
404See: paginationEmpathy Play API - Pagination


Code Block
languagexmljs
{
  "num_found": 123,
  "results": [
    {
      "keyword": "keyword1",
      "results": [
		{
      		"_id": ObjectId(),
      		"enabled": true,
      		"zero_results": false,
      		"references": [
      		  {"ref": "SKU12341234", "title": "..."}
      		],
      		"keywords": ["blue trousers"],
      		"activation_date": null,
      		"deactivation_date": null,
      		"langs": ["en_US", "en_GB"],
      		"extra": {},
    	},
    	...
      ]
    },
    ...
}

...