Versions Compared

Key

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

Method description

...

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

Parameters

Name

Required

Description

keywords(tick)Filter by this keywords


Response format and codes

HTTP code

Description

200OK. Response follows
201Created, Updated
400Invalid parameters. Error response will include details
401The user does not meet the security criteria
404See: pagination


Code Block
languagexml
{
  "num_found": 123,
  "results": [
    {
      "keyword": "keyword",
      "results": [
        {
          	"id": ObjectId(),
        	"type": "DIRECT",
        	"enabled": true,
        	"match_all": false,
        	"title": "Link Title",
        	"url": "https://example.com",
        	"image_name": "a76d566c-9682-425e-a543-6ed482c06127.png",
        	"keywords": ["one keyword", "another keyword"],
        	"weight": 0,
        	"activation_date": null,
        	"deactivation_date": null,
        	"lang": "en",
        	"extra": {},
        },
        ...
      ]
    },
    ...
}

Dependencies

service name

purpose

MongoDBsimple database storage