Creating a bookmark add event

There are many types of events you can send using the Sitecore Search Events API. You might want to track instances of visitors bookmarking content. You can do this using a bookmark add event. If bookmarking 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.

Important

In addition to the default attributes that are required for all events, the entities attribute is required for bookmark add events. The entities array must contain an object representing the entity the user has bookmarked, with at least the id and entity_type attributes included.

The following is an example of a bookmark add event:

Note

For the event object data model, see the Events API reference.

RequestResponseJSON
{
  "name": "bookmark",
  "action": "add",
  "action_sub_type": "conversion",
  "uuid": "<uuid>",
  "client_time_ms": 1234,
  "value": {
    "context": <context object>,
    "entities": [
      {
        "id": "123",
        "entity_type": "content",
        "entity_subtype": "article",
        "attributes": {
           "author": "ABC"
        }
      }
    ],
    "custom_attributes": {
      "bookmark_postition": 3
    }
  }
}

Do you have some feedback for us?

If you have suggestions for improving this article,