Adding descriptions to events, attributes, and event parameters

Events are all actions or occurrences within your website or mobile application done by a customer. All customer activities can be described as events and serve as elements which are necessary for conducting an analysis. On the basis of events you can prepare statistics regarding customer activity, results achieved by your company, etc. To determine the value of the event, you need to use event parameters.

Tip: If you want to count an average value of order in last 30 days, then you use transaction.charge as an event, and totalAmount as an event parameter.

Attributes are elements which can describe an event. Demographic data about customer, like gender, location and contact data (email, phone number etc. and other data connected with them) are the example of event attributes.


Location in the application

  • In Analytics module
  • In Automation module (while building an automated process of segmentation)
  • On the list of activity on a client card in CRM
  • In Assets module (when you want to add new events, event parameters or attributes or edit the existing ones)
  • In client filters

Adding a description

Because you can add your own events and define your own parameters or attributes, it is worth to add description to each of them as sometimes it is not entirely possible to interpret the meaning from the title of event, attribute or event parameter. The added description will be available on the list of events and attributes when you create analytics such as metrics, funnels, segmentations, etc. Just hover the mouse cursor over the element on the list and click the icon on the right side.

Image presents an unfolded dropdown list with events.

Tip: Descriptions to all basic events, attributes and event parameters are already available. You can add your own descriptions to non-standard, custom events, parameters and attributes.

Events and event parameters

Go to Assets -> Events. You can see the list of events. You will see a list of customer properties, along with their names, types (e.g. number, string, boolean, etc.), description (1) and visibility.

Image presents a list of events in Synerise application

  1. If you want to add a description to an existing event, just click the pencil icon that appears when you hover the mouse cursor over the chosen event or you can click three dots on the right side of the list and choose Edit from the context menu.

  2. Add event - If you want to add a new event, click this option. Then you will be able to add a description while creating a new event (detailed description available in the section below).

  3. Add property - If you want to add event parameter, click this option (detailed description how to do it is available in the section below. Properties added to an event are available on the list after you click the name of the event. To add description to an existing property just double click default description of the parameter.

Image presents a list of properties of events with their names, type, description.

Add event

description

  1. Event source - If the event you add is being created on the basis of the existing one, type its name here. If that’s the case, you will see the source name if you hover the mouse cursor over the event on the list.
  2. Event name - Type the name of the parameter. This name will be displayed on the list.
  3. Description - If the name of the event parameter does not clearly informs about the function of the event parameter, write a short description so other users will have no doubts about the parameter function.
  4. Group - Define the groups to which the created parameter belongs.

Add event parameter

description

  1. Source parameter - If the parameter you add is being created on the basis of the existing one, type its name here. If that’s the case, you will see the source name if you hover the mouse cursor over the parameter on the list.
  2. Property name - Type the name of the parameter. This name will be displayed on the list.
  3. Description - If the name of the event parameter does not clearly informs about the function of the event parameter, write a short description so other users will have no doubts about the parameter function.
  4. Property type - When you create an event, you can describe its qualities. To do so, you define the form of those qualities. You can choose from string (text data), date, number, boolean (true or false) or array (data in the form of the list).
  5. Group - Define the groups to which the created parameter belongs. Groups will help you organize the parameters and events.
  6. Link to - You can link this parameter with any attribute. So when you want to describe the values of attributes, you can use event parameter as well.
  7. Show property - By default all added parameters are visible for other users. If you want to change that, switch the button.

Attributes

Go to Assets -> Attributes. You will see a list of customer properties (attributes), along with their names, types (e.g. number, string, boolean, etc.), description (1) and visibility.

description

If you want to add a description (1) to an existing event, just click the pencil icon that appears when you hover the mouse cursor over the chosen event.

  1. Add property - If you want to add a new attribute, click the button. Then you need to repeat the steps described in the section Add property.
  2. If you want to edit an existing attribute, click the three dots and choose Edit from a context menu that displays.
😕

We are sorry to hear that

Thank you for helping improve out documentation. If you need help or have any questions, please consider contacting support.

😉

Awesome!

Thank you for helping improve out documentation. If you need help or have any questions, please consider contacting support.