Contextualize REST API: Events

Owned by Manuel Fachal (Unlicensed)
Last updated: Jun 08, 2018
3 min read

Method description

Process received tagging events to get user behaviours.

HTTP method

POST

Request data

Parameter nameRequiredDescription
events(tick)

The events to process

Events Example

[
  {
    "site_id": "site_id",
    "event_type": "query",
    "metadata": {
        "equalize_id": "equalize_id", // the equalizer identifier applied during the search the request
        "timestamp": 123123123123, // timestamp (in epoch milliseconds) when the event was originated
        "host_referrer": "", // HTTP Referer
        "user_agent": "", // HTTP User-Agent,
        "ip": "127.0.0.1",
        "geo_ip": {
            "country": "ES",
            "city": "Madrid",
            "latitude": 40.417,
            "longitude": -3.703,
        }
    },
    "fields": {
        // global fields
        "user": "user_id_hash",
        "session": "session_id_hash",
        "front": "default",
        "q": "blue dress",
        "page": 1,

        // click/add2cart/wishlist fields
        "title": "Product Title",
        "product_id": "12345678",
        "url": "http://empathybroker.com/",
        "type": 1,
        "position": 1
    },
    "filters": {
        "lang": "en",
        "scope": "mobile",
        "store": "1234",
        "catalog": "5678"
    },
    "extra_fields": {
        "origin": "default",
        "user_type": "recurrent",
        "spellcheck": "false",
        "filtered": "false",
        "contextualize": "true",

        // click/add2cart/wishlist fields
        "boosted": "default",
        "boostedId": "1234"
    },
    "schema_version": "v2"    
  }
]

Responses

200 - successful information retrieve

Type: application/json

Example application/json
{
  "status": "ok",
  "entity": {
    "errors": [
      {
        "position": 3,
        "status": "errors"
      }
    ],
    "ignored": [
      {
        "position": 0,
        "status": "ignored"
      }
    ],
    "processed": [
      {
        "position": 1,
        "status": "ok"
      },
      {
        "position": 2,
        "status": "ok"
      }
    ]
  }
}
401 - the user performing the action doesn't meet the security criteria

Type: application/json

Example application/json
{
  "code": 401,
  "message": "Unauthorized"
}
403 - the token for the user performing the action doesn't have access

Type: application/json

Example application/json
{
  "code": 403,
  "error": "HTTP 403 Forbidden"
}