Skip to end of metadata
Go to start of metadata

You are viewing an old version of this page. View the current version.

Compare with Current View Page History

« Previous Version 7 Next »

Method description

Get a list of links for this instance filtering by keywords. The list is paginated.

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
{
  "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": {},
        },
        ...
      ]
    },
    ...
}
  • No labels