Definition
Global definition
An event is a quantifiable action that happened on your site/app that can be associated to a property.
For instance, displaying a product page will be counted as an event in your data.
Criteria
Name
The label used to designate your event in your tagging and analysis.
Scope
The event scope defines if it is taken into account in the visit calculation.
- On Site Scope adds the event to the visit calculation.
- Off Site Scope withdraws the event from the visit calculation. Offsite events do not feed the "Visitors" metric (except click.campaign.offsite), nor the "Visits" metric, only "Events". However, the "Users" metric is well fed.
The event scope cannot be edited when the event is Validated.
The event name does not have any impact on its scope.
We recommend that you name your events with the scope as we did in standard events such as advertising.display.offsite.
Using "Events" or "Events (all)", events of all scope are taken into account.
Status
Your event has a status that will apply to it a specific treatment.
- Validated: your event feeds your data.
- Waiting for approval: your event is ready to be validated.
Currently, an event cannot be set to a Disabled status.
Categories
An event can be associated to a set of events based on a category.
AT Internet offers categories for standard events, but you can also apply your own categories to set your own groups while searching for your events.
Standard & Custom
Piano Analytics offers Standard events for all its organizations based on the Piano Analytics standard tagging.
You can also create an event that will be only set to your organization.
Number of events available
You can set as many custom events as needed.
The number of events per organization is unlimited.
Create an event
You can create a custom event from the button "+".
The form will ask you to fill in the criteria listed earlier in the article. After the creation of your event, it will take maximum 20 min to be put in production.
Tag an event
The event tagging can be achieved by several ways :
- Activating a standard analysis, Piano Analytics detects specific events thanks to it tagging i.e.: Sales Insights
- Activating a custom analysis, you can specify your own event and initiate from 2 methods:
- Send
Hit is sent when the method is called.
Developer documentation - Add/dispatch
You can specify the content of your event to start, add other events, and then finally trigger hit sending using the dispatch method.
Developer documentation
Edit an event
Standard
You can only set categories on a standard event.
Be careful, though, you cannot withdraw categories associated to an event by Piano Analytics.
Custom
On a custom event, you can always edit all its associated categories.
However, it is not possible to change the scope of an event once it has been registered. This would have too many repercussions on historical and future data.
Deactivate an event
You cannot deactivate an event in your data model, as this would lead to inconsistencies in the history and potential recalculations of the data.