IMPORTANT: No additional bug fixes or documentation updates
will be released for this version. For the latest information, see the
current release documentation.
Analytics events reference
editAnalytics events reference
editBehavioral 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
editBase fields
edit-
@timestamp
- UTC timestamp of the event.
-
data_stream.dataset
-
Datastream dataset type:
elastic_analytics.events
. -
data_stream.namespace
- Datastream namespace: corresponds to the events collection name.
-
data_stream.type
-
Datastream type:
logs
. -
ecs.version
- Elastic Common Schema version.
Event fields
edit-
event.action
-
Action:
click
,search
, orpageview
. -
event.dataset
-
Dataset:
elastic_analytics.events
. -
event.user_agent
- User agent string.
-
event.customer_data.action
-
User action: for example
add_to_cart
. -
event.customer_data.category
-
Category: for example
product
. -
event.customer_data.field
-
Field: for example
product_id
. -
event.customer_data.label
-
Label: for example
product_name
. -
event.customer_data.query
- Search query.
-
event.customer_data.totalResults
- Total results for a search query.
-
event.customer_data.type
-
Event type: for example
SearchQuery
. -
event.customer_data.value
-
Event value: for example
product_price
.
Labels fields
edit-
labels.index_date
- Date the event was indexed.
-
labels.session_uuid
- Session UUID.
-
labels.user_uuid
- User UUID.
User agent fields
edit-
user_agent.device.name
-
Device name: for example
Mac
. -
user_agent.name
-
User agent name: for example
Chrome
. -
user_agent.original
- User agent string.
-
user_agent.os.full
-
Full operating system details: for example
Mac OS X 10.15.7
. -
user_agent.os.name
-
Operating system name: for example
Mac OS X
. -
user_agent.os.version
- Operating system version.
-
user_agent.version
- User agent version.
URL fields
editThese fields are only present for pageview
events.
-
url.domain
-
Domain component of the URL.
For example
www.elastic.co
. -
url.path
-
Path component of the URL.
For example
/search
. -
url.port
-
Port component of the URL.
For example
80
or443
. -
url.scheme
-
Scheme component of the URL.
For example
http
orhttps
.
Examples
editExpand to see a full example of a click
event data object:
{ "@timestamp": [ "2023-02-13T16:14:37.730Z" ], "data_stream.dataset": [ "elastic_analytics.events" ], "data_stream.namespace": [ "test" ], "data_stream.type": [ "logs" ], "ecs.version": [ "1.7.0" ], "event.action": [ "click" ], "event.dataset": [ "elastic_analytics.events" ], "event.user_agent": [ "Mozilla/5.0 (Macintosh; Intel Mac OS X 10_15_7) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/110.0.0.0 Safari/537.36" ], "labels.index_date": [ "2023.02.13" ], "labels.session_uuid": [ "0273eae9-3b41-461f-884b-99d3e9a5a0ce" ], "labels.user_uuid": [ "6c101073-e7e2-4ddb-87af-6ede3c88b7c8" ], "user_agent.device.name": [ "Mac" ], "user_agent.name": [ "Chrome" ], "user_agent.original": [ "Mozilla/5.0 (Macintosh; Intel Mac OS X 10_15_7) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/110.0.0.0 Safari/537.36" ], "user_agent.os.full": [ "Mac OS X 10.15.7" ], "user_agent.os.name": [ "Mac OS X" ], "user_agent.os.version": [ "10.15.7" ], "user_agent.version": [ "110.0.0.0" ], "_id": "-4mOS4YBRbD3B9XzmOks", "_index": ".ds-logs-elastic_analytics.events-test-2023.02.09-000001", "_score": null }
Expand to see a full example of a pageview
event data object:
{ "@timestamp": [ "2023-02-13T16:14:32.707Z" ], "data_stream.dataset": [ "elastic_analytics.events" ], "data_stream.namespace": [ "test" ], "data_stream.type": [ "logs" ], "ecs.version": [ "1.7.0" ], "event.action": [ "pageview" ], "event.dataset": [ "elastic_analytics.events" ], "event.user_agent": [ "Mozilla/5.0 (Macintosh; Intel Mac OS X 10_15_7) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/110.0.0.0 Safari/537.36" ], "labels.index_date": [ "2023.02.13" ], "labels.session_uuid": [ "0273eae9-3b41-461f-884b-99d3e9a5a0ce" ], "labels.user_uuid": [ "6c101073-e7e2-4ddb-87af-6ede3c88b7c8" ], "url.domain": [ "localhost" ], "url.path": [ "/" ], "url.port": [ 3000 ], "url.scheme": [ "http" ], "user_agent.device.name": [ "Mac" ], "user_agent.name": [ "Chrome" ], "user_agent.original": [ "Mozilla/5.0 (Macintosh; Intel Mac OS X 10_15_7) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/110.0.0.0 Safari/537.36" ], "user_agent.os.full": [ "Mac OS X 10.15.7" ], "user_agent.os.name": [ "Mac OS X" ], "user_agent.os.version": [ "10.15.7" ], "user_agent.version": [ "110.0.0.0" ], "_id": "n8WOS4YBcuSEZLL0fOzR", "_index": ".ds-logs-elastic_analytics.events-test-2023.02.09-000001", "_score": null }