Skip to main content

Events API reference and data model

Abstract

Where to find reference information for the Events API for Sitecore Search.

When working with the Events API, refer to the API reference for the detailed data model and descriptions of objects and keys.

The following is a sample data model of the API request:

{
  "action": "click, view",
  "action_sub_type": "conversion",
  "client_time_ms": 1660088972963,
  "interaction_id": "test_interaction_id",
  "name": "\"content\", \"entity_page\", \"widget\"",
  "page_load_time_ms": 1660088972963,
  "request_id": "test_request_id",
  "user_id": "string",
  "uuid": "125757322-qu-y8-4u-1p-j4y9f17bqqlrqtl36uqf-1647596322309",
  "value": {
    "context": {
      "browser": {
        "app_type": "browser",
        "device": "mobile",
        "user_agent": "Mozilla/5.0 (iPhone14,6; U; CPU iPhone OS 15_4 like Mac OS X) AppleWebKit/602.1.50 (KHTML, like Gecko) Version/10.0 Mobile/19E241 Safari/602.1"
      },
      "geo": {
        "city": "San Francisco",
        "country": "us",
        "ip": "207.242.49.4",
        "state": "CA",
        "zip": "94403"
      },
      "page": {
        "locale_country": "us",
        "locale_currency": "usd",
        "locale_language": "en",
        "referrer": "test_referer",
        "title": "test_title",
        "uri": "test_uri"
      },
      "user": {
        "addn_attributes": "string",
        "address": {
          "address_line_1": "9090 Main Street",
          "address_line_2": "Unit 204",
          "country": "US",
          "state": "CA",
          "zip": "99999"
        },
        "cuid": "test_cuid",
        "eid": "test_eid",
        "email": "test@gmail.com",
        "fbid": "test_fbid",
        "gender": "male",
        "segments": [
          "string"
        ]
      }
    },
    "entities": [
      {
        "attributes": {
          "author": "XYZ"
        },
        "entity_subtype": "article blog",
        "entity_type": "content, product",
        "id": "678",
        "uri": "https://docs.test.com/en/678/"
      }
    ],
    "rfkid": "rfkid_1"
  }
}