Behavioral Analytics events reference

Behavioral Analytics events reference

Behavioral Analytics logs events using the Elastic Common Schema, including a custom field set for analytics events. Refer to examples of the full data objects that are logged.

Fields overview

Common event fields

@timestamp

Timestamp of the event.

event.action

The type of event. Possible values are search, search_click, and pageview.

event.source

The source of the event. Possible values are client and server.

session.id

A unique identifier for the session.

user.id

A unique identifier for the user.

_id

The document ID.

_index

The index name.

_score

The score of the document.

Search event fields

search.filters

The filters applied to the search query.

search.query

The search query.

search.results.items.document.id

The ID of the document in the search results.

search.results.items.document.index

The index of the document in the search results.

search.results.items.page.url.domain

The URL domain of the page in the search results.

search.results.items.page.url.original

The original URL of the page in the search results.

search.results.items.page.url.path

The URL path of the page in the search results.

search.results.items.page.url.scheme

The URL scheme of the page in the search results.

search.results.total_results

The total number of results returned by the search query.

search.search_application

The search application used to perform the search query.

search.sort.name

The name of the sort applied to the search query.

Search click event fields

document.id

The ID of the document that was clicked.

document.index

The index containing the document that was clicked.

page.url.domain

The URL domain of the page that was clicked.

page.url.original

The original URL of the page that was clicked.

page.url.path

The URL path of the page that was clicked.

page.url.scheme

The URL scheme of the page that was clicked.

search.filters

The filters applied to the search query.

search.query

The search query.

search.results.items.document.id

The ID of the document in the search results.

search.results.items.document.index

The index of the document in the search results.

search.results.items.page.url.domain

The URL domain of the page in the search results.

search.results.items.page.url.original

The original URL of the page in the search results.

search.results.items.page.url.path

The URL path of the page in the search results.

search.results.items.page.url.scheme

The URL scheme of the page in the search results.

search.results.total_results

The total number of results returned by the search query.

search.search_application

The search application used to perform the search query.

search.sort.name

The name of the sort applied to the search query.

session.location.country_iso_code

The ISO code of the country where the search click occurred.

session.location.country_name

The name of the country where the search click occurred.

Pageview event fields

document.id

The ID of the document that was viewed.

document.index

The index containing the document that was viewed.

page.referrer.domain

The URL domain of the page that referred to the viewed page.

page.referrer.original

The original URL of the page that referred to the viewed page.

page.referrer.path

The path of the page that referred to the viewed page.

page.referrer.scheme

The URL scheme of the page that referred to the viewed page.

page.title

The title of the viewed page.

page.url.domain

The URL domain of the viewed page.

page.url.original

The original URL of the viewed page.

page.url.path

The URL path of the viewed page.

page.url.scheme

The URL scheme of the viewed page.

session.location.country_iso_code

The ISO code of the country where the pageview occurred.

session.location.country_name

The name of the country where the pageview occurred.

Examples

Expand to see a full example of a search event data object:

  1. {
  2.   "@timestamp": [
  3.     "2023-05-16T12:52:29.003Z"
  4.   ],
  5.   "event.action": [
  6.     "search"
  7.   ],
  8.   "event.source": [
  9.     "client"
  10.   ],
  11.   "search.filters": [
  12.     {
  13.       "color": [
  14.         "silver"
  15.       ],
  16.       "brand": [
  17.         "Robel, Klocko and Ziemann",
  18.         "McClure, Marks and Mertz"
  19.       ]
  20.     }
  21.   ],
  22.   "search.query": [
  23.     "transformation"
  24.   ],
  25.   "search.results.items.document.id": [
  26.     "045a164b-229e-40b5-ba66-b2ebabd2a251"
  27.   ],
  28.   "search.results.items.document.index": [
  29.     "products"
  30.   ],
  31.   "search.results.items.page.url.domain": [
  32.     "fancy-overcoat.org"
  33.   ],
  34.   "search.results.items.page.url.original": [
  35.     "http://fancy-overcoat.org/happy/pancakes/deals"
  36.   ],
  37.   "search.results.items.page.url.path": [
  38.     "/happy/pancakes/deals"
  39.   ],
  40.   "search.results.items.page.url.scheme": [
  41.     "http"
  42.   ],
  43.   "search.results.total_results": [
  44.     67
  45.   ],
  46.   "search.search_application": [
  47.     "search-ui"
  48.   ],
  49.   "search.sort.name": [
  50.     "relevance"
  51.   ],
  52.   "session.id": [
  53.     "2bc31b08-d443-4b7a-81ea-65edf3dd82e7"
  54.   ],
  55.   "user.id": [
  56.     "42704a4b-692b-4654-bb67-a65eb0c72f15"
  57.   ],
  58.   "_id": "y3IBBogBWHKTU-4a543S",
  59.   "_index": ".ds-behavioral_behavioral-analytics-event-website-2023.05.10-000001",
  60.   "_score": null
  61. }

Expand to see a full example of a search_click event data object:

  1. {
  2.   "@timestamp": [
  3.     "2023-05-16T12:22:23.468Z"
  4.   ],
  5.   "document.id": [
  6.     "38cca784-109a-4ea0-a4e8-60c3be667ffd"
  7.   ],
  8.   "document.index": [
  9.     "products"
  10.   ],
  11.   "event.action": [
  12.     "search_click"
  13.   ],
  14.   "event.source": [
  15.     "client"
  16.   ],
  17.   "page.url.domain": [
  18.     "unfurnished-appartments"
  19.   ],
  20.   "page.url.original": [
  21.     "https://unfurnished-appartments/new/europe"
  22.   ],
  23.   "page.url.path": [
  24.     "/new/europe"
  25.   ],
  26.   "page.url.scheme": [
  27.     "https"
  28.   ],
  29.   "search.filters": [
  30.     {
  31.       "brand": [
  32.         "McClure, Marks and Mertz",
  33.         "Ondricka - Rath"
  34.       ]
  35.     }
  36.   ],
  37.   "search.query": [
  38.     "ferryboat"
  39.   ],
  40.   "search.results.items.document.id": [
  41.     "0c76967b-4915-446e-9b2c-b1bfb9e39e1e"
  42.   ],
  43.   "search.results.items.document.index": [
  44.     "products"
  45.   ],
  46.   "search.results.items.page.url.domain": [
  47.     "dependent-lecture.info"
  48.   ],
  49.   "search.results.items.page.url.original": [
  50.     "http://dependent-lecture.info/documents/additional/latest"
  51.   ],
  52.   "search.results.items.page.url.path": [
  53.     "/documents/additional/latest"
  54.   ],
  55.   "search.results.items.page.url.scheme": [
  56.     "http"
  57.   ],
  58.   "search.results.total_results": [
  59.     54
  60.   ],
  61.   "search.search_application": [
  62.     "search-ui"
  63.   ],
  64.   "search.sort.name": [
  65.     "relevance"
  66.   ],
  67.   "session.id": [
  68.     "9411fb93-8707-49a4-baab-cec4d6aef753"
  69.   ],
  70.   "session.location.country_iso_code": [
  71.     "GP"
  72.   ],
  73.   "session.location.country_name": [
  74.     "Guadeloupe"
  75.   ],
  76.   "user.id": [
  77.     "911d0c19-e713-4413-8f4c-c6c612bc37c4"
  78.   ],
  79.   "_id": "m8cBBogBG4-Ak0Iy7LME",
  80.   "_index": ".ds-behavioral_behavioral-analytics-event-website-2023.05.10-000001",
  81.   "_score": null
  82. }

Expand to see a full example of a pageview event data object:

  1. {
  2.   "@timestamp": [
  3.     "2023-05-16T12:52:51.309Z"
  4.   ],
  5.   "document.id": [
  6.     "c98ppfc8-3a04-4a20-888a-f87292b31181"
  7.   ],
  8.   "document.index": [
  9.     "products"
  10.   ],
  11.   "event.action": [
  12.     "page_view"
  13.   ],
  14.   "event.source": [
  15.     "client"
  16.   ],
  17.   "page.referrer.domain": [
  18.     "happy-pancakes.name"
  19.   ],
  20.   "page.referrer.original": [
  21.     "https://happy-pancakes.name/magnam"
  22.   ],
  23.   "page.referrer.path": [
  24.     "/magnam"
  25.   ],
  26.   "page.referrer.scheme": [
  27.     "https"
  28.   ],
  29.   "page.title": [
  30.     "Super fast delivery"
  31.   ],
  32.   "page.url.domain": [
  33.     "happy-staircase.net"
  34.   ],
  35.   "page.url.original": [
  36.     "http://happy-staircase.net/quam"
  37.   ],
  38.   "page.url.path": [
  39.     "/quam"
  40.   ],
  41.   "page.url.scheme": [
  42.     "http"
  43.   ],
  44.   "session.id": [
  45.     "2bc31b08-d443-4b7a-81ea-65edf3dd82e7"
  46.   ],
  47.   "session.location.country_iso_code": [
  48.     "SN"
  49.   ],
  50.   "session.location.country_name": [
  51.     "Senegal"
  52.   ],
  53.   "user.id": [
  54.     "42704a4b-692b-4654-bb67-a65eb0c72f15"
  55.   ],
  56.   "_id": "zHIBBogBWHKTU-4a543S",
  57.   "_index": ".ds-behavioral_behavioral-analytics-event-website-2023.05.10-000001",
  58.   "_score": null
  59. }