Передача взаимодействия пользователя с кампаниями

Для сбора статистики и последующей оптимизации кампаний необходимо передавать информацию о взаимодействиях пользователя с кампаниями.

post

Report user engagement (clicks) with a variation or a recommended item.

Authorizations

Body

userobjectrequired

User ID. A Gravity Field-generated identifier is used, and managed via cookies. For a new user, send this object empty.

sessionobjectrequired

Session ID. A Gravity Field-generated identifier is used. For new sessions, send this object empty.

contextobjectrequired

The request's context.

engagementsobject[]required

Report the type of engagement with a reference to the content or recommendation that the user engaged with.

Responses

application/json

text/plain

application/json

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --request POST \
  --url 'https://evs.gravityfield.ai/ssapi/engagement' \
  --header 'Authorization: Bearer API-KEY' \
  --header 'Content-Type: application/json' \
  --data '{
    "user": {
      "id": "100"
    },
    "session": {
      "custom": "custom_session_100"
    },
    "context": {
      "page": {
        "type": "PRODUCT",
        "data": [
          "sku_1"
        ],
        "location": "https://test.ru/product/sku_1"
      },
      "device": {
        "userAgent": "Mozilla/5.0 ...",
        "ip": "8.8.8.8"
      }
    },
    "engagements": [
      {
        "type": "WRIMP",
        "decisionId": "65f2a818f56efdf37c00228b:65f2a818f56efdf37c002294:65f2a818f56efdf37c00228e:65f2a818f56efdf37c002292"
      }
    ]
  }'

EventAPIViewWidgetEventHybridMultipleInvalidContextData

200

204

401

422

200

{
  "session": {
    "sl": "58DA42F2-BD26-4517-A81B-4DA4369E2529"
  }
}

Successful response