Передача событий и просмотров

Для того, чтобы иметь возможность собирать статистику и оптимизировать кампании, необходимо передавать в платформу информацию о действиях пользователя, а также просмотры страниц (экранов в приложении).

Передача событий

Минимально рекомендуемый список передаваемых событий:

• addToCart (добавление в корзину)

• purchase (покупка)

post

Report a predefined or custom event.

Authorizations

Body

Responses

200

Successful store event

application/json

204

Successful response

text/plain

401

Access token is missing or invalid

422

Error validation request data

application/json

post

HTTPcURLJavaScriptPython

POST /ssapi/event HTTP/1.1
Host: evs.gravityfield.ai
Authorization: Bearer API-KEY
Content-Type: application/json
Accept: */*
Content-Length: 479

{
  "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"
    }
  },
  "events": [
    {
      "name": "Purchased online",
      "properties": {
        "eventType": "purchase-v1",
        "value": 100,
        "uniqueTransactionId": "f8709115-eeaa-404d-84da-a1eeafb82e0e",
        "cart": [
          {
            "productId": "sku_1",
            "quantity": 2,
            "itemPrice": 10
          },
          {
            "productId": "sku_2",
            "quantity": 1,
            "itemPrice": 80
          }
        ]
      }
    }
  ]
}

EventAPIPurchasedEventHybridAddToCartEventHybridAuthorizationEventStoreUserAndAuthorizationCuidInvalidContextData

{
  "user": {
    "slid": "65fafcdae8dc0a8e690a4102"
  },
  "session": {
    "sl": "58DA42F2-BD26-4517-A81B-4DA4369E2529"
  }
}

Просмотр страницы (экрана)

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

При использовании гибридной интеграции информацию о просмотре страницы необходимо передавать в том случае, если на этой странице не проведена фронтовая интеграция.

post

Report a pageview without choosing variations for any campaigns. This endpoint has the same effect as calling choose with an empty selector argument.

Authorizations

Body

Responses

200

Successful store event

application/json

204

Successful response

text/plain

401

Access token is missing or invalid

422

Error validation request data

application/json

post

HTTPcURLJavaScriptPython

POST /ssapi/page HTTP/1.1
Host: evs.gravityfield.ai
Authorization: Bearer API-KEY
Content-Type: application/json
Accept: */*
Content-Length: 217

{
  "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"
    }
  }
}

PageViewAPIProductPageViewHybridCartStoreUserAndPageViewInvalidContextData

{
  "user": {
    "slid": "65fafcdae8dc0a8e690a4102"
  },
  "session": {
    "sl": "58DA42F2-BD26-4517-A81B-4DA4369E2529"
  }
}