Skip to content
This repository was archived by the owner on May 5, 2026. It is now read-only.

Standard events

Benjamin Diolez edited this page May 5, 2026 · 1 revision

Data collection / Piano Analytics / Event tagging piano analytics / Standard events

Forewords

One of the strengths of Piano Analytics data model is that it offers standard events and properties that are present by default.

These events will allow you to measure the majority of interactions present on your perimeters. So there is no need to reinvent an event from scratch when you just want to measure the loading of a page, or the consultation of a product page! Moreover, the use of these standard events allows us to provide you with dedicated metrics. For example, the time spent per page is a metric linked to the use of the standard page view event page.display.

Each standard event can be linked to standard properties dedicated to it.

However, it is not mandatory to use each of the informed properties, and it is quite possible to add other properties (standard or custom) if you wish.

User

In order to track your logged users, you can use the following properties:

Properties Type Example
user_id String A1192
user_category String Premium

Content

Pages

Event name :

page.display

Standard properties linked:

Properties Type Example
page String Article3
page_chapter1 String News
page_chapter2 String Politique
page_chapter3 String Elections

The property definition is available within your data model.

Tagging example:

tag.events.send('page.display',
  {
    'page': 'page name',
    'page_chapter1': 'chapter 1' ,
    'page_chapter2': 'chapter 2' ,
    'page_chapter3': 'chapter 3' 
  }
);
_ = tracker.events.add(name: "page.display", data:
  "page" : "page name",
  "page_chapter1" : "chapter 1",
  "page_chapter2" : "chapter 2",
  "page_chapter3" : "chapter 3"
)
tracker.dispatch()
tracker.Events().add("page.display", new HashMap
() {{
  put("page", "page name");
  put("page_chapter1", "chapter 1");
  put("page_chapter2", "chapter 2");
  put("page_chapter3", "chapter 3");
}})
tracker.dispatch();

Clicks

Event name :

click.navigation click.action click.exit click.download

Standard properties linked:

properties Type Example
click String Article3
click_chapter1 String News
click_chapter2 String Politique
click_chapter3 String Elections

The property definition is available within your data model.

Tagging example:

tag.events.send('click.navigation',
  {
    'click': 'click name',
    'click_chapter1': 'chapter 1',
    'click_chapter2': 'chapter 2',
    'click_chapter3': 'chapter 3' 
  }
);
_ = tracker.events.add(name: "click.navigation", data:
  "click": "click name",
  "click_chapter1": "chapter 1",
  "click_chapter2": "chapter 2",
  "click_chapter3": "chapter 3"
)
tracker.dispatch()
tracker.Events().add("click.navigation", new HashMap
() {{
  put("click", "click name");
  put("click_chapter1", "chapter 1");
  put("click_chapter2", "chapter 2");
  put("click_chapter3", "chapter 3");
}})
tracker.dispatch();

Internal search engine

Results display

Event name :

internal_search_result.display

Standard properties linked:

properties Type Example
ise_keyword String Mobile Phone
ise_page Int 2

The property definition is available within your data model.

Tagging example:

tag.events.send('internal_search_result.display',
  {
    'ise_keyword': 'Mobile Phone',
    'ise_page': 2
  }
);
_ = tracker.events.add(name: "internal_search_result.display", data:
  "ise_keyword": "Mobile Phone",
  "ise_page": 2
)
tracker.dispatch()
tracker.Events().add("internal_search_result.display", new HashMap
() {{
  put("ise_keyword", "Mobile Phone");
  put("ise_page", 2);
}})
tracker.dispatch();

Results clicks

Event name :

internal_search_result.click

Standard properties linked:

properties Type Example
ise_keyword String Mobile Phone
ise_page Int 2
ise_click_rank Int 15

The property definition is available within your data model.

Tagging example:

tag.events.send('internal_search_result.click',
  {
    'ise_keyword': 'Mobile Phone',
    'ise_page': 2,
    'ise_click_rank': 15
  }
);
_ = tracker.events.add(name: "internal_search_result.click", data:
  "ise_keyword": "Mobile Phone",
  "ise_page": 2,
  "ise_click_rank": 15
)
tracker.dispatch()
tracker.Events().add("internal_search_result.click", new HashMap
() {{
  put("ise_keyword", "Mobile Phone");
  put("ise_page", 2);
  put("ise_click_rank", 15);
}})
tracker.dispatch();

Goals

In order to track conversion goals, you can use the following property:

Properties Type Example
goal_type String Account creation

On Site Ads

Event name :

publisher.display publisher.click self_promotion.display self_promotion.click

Standard properties linked:

properties Type Example
onsitead_type (required) String Publisher
onsitead_campaign String Acquisition
onsitead_category String Gold
onsitead_creation String Banner_main
onsitead_variant String Blue
onsitead_format String 400×300
onsitead_general_placement String Sidebar
onsitead_detailed_placement String Sidebar_bottom
onsitead_advertiser String My Site
onsitead_url String www.mysite.com

The property definition is available within your data model.

awaiti

tag.events.send('publisher.display',
  {
    'onsitead_type': 'Publisher',
    'onsitead_campaign': 'Acquisition',
    'onsitead_category': 'Gold',
    'onsitead_creation': 'Banner_main',
    'onsitead_variant': 'Blue',
    'onsitead_format': '400x300',
    'onsitead_general_placement': 'Sidebar',
    'onsitead_detailed_placement': 'Sidebar_bottom',
    'onsitead_advertiser': 'My Site',
    'onsitead_url': 'www.mysite.com'
  }
);
_ = tracker.events.add(name: "publisher.display", data:
  "onsitead_type": "Publisher",
  "onsitead_campaign": "Acquisition",
  "onsitead_category": "Gold",
  "onsitead_creation": "Banner_main",
  "onsitead_variant": "Blue",
  "onsitead_format": "400x300",
  "onsitead_general_placement": "Sidebar",
  "onsitead_detailed_placement": "Sidebar_bottom",
  "onsitead_advertiser": "My Site",
  "onsitead_url": "www.mysite.com"
)
tracker.dispatch()
tracker.Events().add("publisher.display", new HashMap
() {{
  put("onsitead_type", "Publisher",);
  put("onsitead_campaign", "Acquisition",);
  put("onsitead_category", "Gold",);
  put("onsitead_creation", "Banner_main",);
  put("onsitead_variant", "Blue",);
  put("onsitead_format", "400x300",);
  put("onsitead_general_placement", "Sidebar",);
  put("onsitead_detailed_placement", "Sidebar_bottom",);
  put("onsitead_advertiser", "My Site",);
  put("onsitead_url", "www.mysite.com",);
}})
tracker.dispatch();

Wiki contents

Clone this wiki locally