/<instance_id>/links - GET

Method description

Get a list of links for the client {instance_id}. The result list is paginated.

URI Parameters

Paramenter Name	Required	Description
rows		See: Empathy Play API - Pagination
offset		See: Empathy Play API - Pagination
state		Filter by enabled/disabled state
type		Filter by link type
lang		Filter by link language
kw		Filter by link keywords
pkw		Filter by link keywords (partial search)

Response format and codes

200 - successful information retrieve

Type: application/json

Example application/json

{
  "num_found": 9,
  "results": [
    {
      "activation_date": null,
      "created_on": "2017-08-08T15:27:43",
      "deactivation_date": null,
      "enabled": true,
      "extra": {
        "user": "-"
      },
      "id": "5989d86fe6ece90012a92766",
      "image_url": null,
      "keywords": [
        "raffle"
      ],
      "lang": "en",
      "match_all": false,
      "title": "Raffle",
      "type": "DIRECT",
      "updated_on": "2017-08-08T15:27:43",
      "url": "http://empathybroker.com/raffle",
      "weight": 0
    },
    {
      "activation_date": null,
      "created_on": "2017-08-08T15:27:44",
      "deactivation_date": null,
      "enabled": true,
      "extra": {
        "user": "-"
      },
      "id": "5989d870e6ece90012a92767",
      "image_url": null,
      "keywords": [
        "returns",
        "return"
      ],
      "lang": "en",
      "match_all": false,
      "title": "Returning goods",
      "type": "PROMOTED",
      "updated_on": "2017-08-08T15:27:44",
      "url": "http://empathybroker.com/delivery-info",
      "weight": 9
    },
    {
      "activation_date": "2015-12-20T00:00:00",
      "created_on": "2017-08-08T15:27:44",
      "deactivation_date": "2015-12-25T00:00:00",
      "enabled": false,
      "extra": {
        "user": "-"
      },
      "id": "5989d8701f3319000c833528",
      "image_url": null,
      "keywords": [
        "kids"
      ],
      "lang": "en",
      "match_all": false,
      "title": "http://empathybroker.com/children/partywear/boys",
      "type": "DIRECT",
      "updated_on": "2017-08-08T15:27:44",
      "url": "http://empathybroker.com/children/partywear/boys",
      "weight": 0
    },
    {
      "activation_date": null,
      "created_on": "2017-08-08T15:27:44",
      "deactivation_date": null,
      "enabled": true,
      "extra": {
        "user": "-"
      },
      "id": "5989d8701f3319000b83352f",
      "image_url": "https://preassets.empathybroker.com/images/4edaf2aa-b2ac-460c-b6d1-5d7a172e89f",
      "keywords": [
        "trousers"
      ],
      "lang": "en",
      "match_all": false,
      "title": "trousers",
      "type": "BANNER",
      "updated_on": "2017-08-08T15:27:45",
      "url": "http://www.google.es",
      "weight": 9
    }
  ]
}

400 - Invalid parameters. Error response will include details

Type: application/json

Example application/json

{
  "code": 400,
  "details": "\"rows\" must be in range 10-200",
  "message": "Bad Request",
  "status": "error"
}

401 - the user performing the action doesn't meet the security criteria

Type: application/json

Example application/json

{
  "code": 401,
  "details": "The server could not verify that you are authorized to access the URL requested.  You either supplied the wrong credentials (e.g. a bad password), or your browser doesn't understand how to supply the credentials required.",
  "message": "Unauthorized",
  "status": "error"
}

404 - the instance doesn't exist or offset is wrong

Type: application/json

Example application/json

{
  "code": 404,
  "details": "",
  "message": "Not Found",
  "status": "error"
}

See: Empathy Play API - Pagination