Creating an entity download event
There are many types of events you can send using the Sitecore Search Events API. You might want to track instances of visitors downloading content. You can do this using an entity download
event. If downloading content counts as a conversion for your business, you can mark this event as a conversion by setting the action_sub_type
key to conversion.
In addition to the default attributes that are required for all events, the entities
attribute is required for entity download
events. The entities
array must contain an object representing the entity the user has downloaded, with at least the id
and entity_type
attributes included.
The following is an example of an entity download
event:
For the event object data model, see the Events API reference.
{
"name": "download",
"action": "add",
"uuid": "<uuid>",
"client_time_ms": 1234,
"value": {
"context": <context object>,
"entities": [
{
"id": "123"
"entity_type": "content",
"entity_subtype": "article",
"attributes": {
"author": "ABC"
}
}
]
}
}