Method description

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

URI Parameters

Parameter Name	Required	Description
rows		See: Empathy Play API - Pagination
offset		See: Empathy Play API - Pagination
enabled		Filter by enabled/disabled state
visible		Filter by boost is activated or not on request time
lang		Filter by boost language
kw		Filter by boost keywords
pkw		Filter by boost keywords (partial search)

Responses

200 - successful information retrieve

Type: application/json

Example application/json

{
  "num_found": 13,
  "results": [
    {
      "activation_date": "2016-10-25T22:00:00",
      "created_on": "2017-08-08T15:27:52",
      "deactivation_date": "2017-04-25T22:00:00",
      "enabled": false,
      "extra": {
        "user": "-"
      },
      "id": "5989d878e6ece90011a9276c",
      "keywords": [
        "ring"
      ],
      "langs": [
        "en"
      ],
      "references": [
        {
          "ref": "19430508",
          "title": "Eternity Ring"
        }
      ],
      "updated_on": "2017-08-08T15:27:52",
      "zero_results": false
    },
    {
      "activation_date": "2016-10-15T00:00:00",
      "created_on": "2017-08-08T15:27:53",
      "deactivation_date": "2017-10-15T00:00:00",
      "enabled": true,
      "extra": {
        "user": "-"
      },
      "id": "5989d8791f3319000c833529",
      "keywords": [
        "yellow"
      ],
      "langs": [
        "en"
      ],
      "references": [
        {
          "ref": "11211043",
          "title": "Baby Clarabella Lace Print Dress"
        }
      ],
      "updated_on": "2017-08-08T15:27:53",
      "zero_results": false
    }
  ]
}

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

/<instance_id>/boosts/search - GET [DEPRECATED]