Standard events

Page display

Event name

page.display

Standard properties

Property	Type
page	string
page_chapter1	string
page_chapter2	string
page_chapter3	string

Javascript

pa.sendEvent('page.display', {
  'page' : 'page name',
  'page_chapter1' : 'level 1',
  'page_chapter2' : 'level 2',
  'page_chapter3' : 'level 3',
});

Android (3.3.0+)

PianoAnalytics.getInstance().sendEvents(
  Event.Builder("page.display")
    .properties(
      Property(PropertyName("page"), "page name"),
      Property(PropertyName("page_chapter1"), "level 1"),
      Property(PropertyName("page_chapter2"), "level 2"),
      Property(PropertyName("page_chapter3"), "level 3"),
    )
    .build()
)

Android

pa.sendEvent(new Event("page.display", new HashMap<String, Object>() {{
  put("page", "page name");
  put("page_chapter1", "level 1");
  put("page_chapter2", "level 2");
  put("page_chapter3", "level 3");
}}));

Apple

pa.sendEvent(Event("page.display", data: [
  "page" : "page name",
  "page_chapter1" : "level 1",
  "page_chapter2" : "level 2",
  "page_chapter3" : "level 3"
]))

Flutter

await _pianoAnalytics.sendEvents(events: [
  Event(name: "page.display", properties: [
    Property.string(name: "page"), value: "page name"),
    Property.string(name: "page_chapter1"), value: "level 1"),
    Property.string(name: "page_chapter2"), value: "level 2"),
    Property.string(name: "page_chapter3"), value: "level 3"),
  ])
]);

HTTP

const site_id = `XXXXXXXXXX`;
const visitor_id = `<visitor_id>`;
const endpoint = `<xxxxxxx>.pa-cd.com`;

fetch(`https://${endpoint}/event?s=${site_id}&idclient=${visitor_id}`, {
  method: "POST",
  body: JSON.stringify({
    events: [{
      name: "page.display",
      data: {
        "page": "page name",
        "page_chapter1": "level 1",
        "page_chapter2": "level 2",
        "page_chapter3": "level 3"
      }
    }]
  })
})

Edit code sample

Clicks

Event name

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

Standard properties

Property	Type
click	string
click_chapter1	string
click_chapter2	string
click_chapter3	string

Javascript

pa.sendEvent('click.action', {
  'click' : 'click name',
  'click_chapter1' : 'level 1',
  'click_chapter2' : 'level 2',
  'click_chapter3' : 'level 3',
});

Android (3.3.0+)

PianoAnalytics.getInstance().sendEvents(
  Event.Builder("click.action")
    .properties(
      Property(PropertyName("click"), "click name"),
      Property(PropertyName("click_chapter1"), "level 1"),
      Property(PropertyName("click_chapter2"), "level 2"),
      Property(PropertyName("click_chapter3"), "level 3"),
    )
    .build()
)

Android

pa.sendEvent(new Event("click.action", new HashMap<String, Object>() {{
  put("click", "click name");
  put("click_chapter1", "level 1");
  put("click_chapter2", "level 2");
  put("click_chapter3", "level 3");
}}));

Apple

pa.sendEvent(Event("click.action", data: [
  "click" : "click name",
  "click_chapter1" : "level 1",
  "click_chapter2" : "level 2",
  "click_chapter3" : "level 3"
]))

Flutter

await _pianoAnalytics.sendEvents(events: [
  Event(name: "click.action", properties: [
    Property.string(name: "click"), value: "click name"),
    Property.string(name: "click_chapter1"), value: "level 1"),
    Property.string(name: "click_chapter2"), value: "level 2"),
    Property.string(name: "click_chapter3"), value: "level 3"),
  ])
]);

HTTP

const site_id = `XXXXXXXXXX`;
const visitor_id = `<visitor_id>`;
const endpoint = `<xxxxxxx>.pa-cd.com`;

fetch(`https://${endpoint}/event?s=${site_id}&idclient=${visitor_id}`, {
  method: "POST",
  body: JSON.stringify({
    events: [{
      name: "click.action",
      data: {
        "click": "click name",
        "click_chapter1": "level 1",
        "click_chapter2": "level 2",
        "click_chapter3": "level 3"
      }
    }]
  })
})

Edit code sample

Onsite Ads

Event name

publisher.impression / publisher.click / self_promotion.impression / self_promotion.click

Standard properties

Property	Type	Possible value
onsitead_type (mandatory)	string	Publisher / Self promotion
onsitead_advertiser	string
onsitead_campaign	string
onsitead_category	string
onsitead_creation	string
onsitead_detailed_placement	string
onsitead_format	string
onsitead_general_placement	string
onsitead_url	string
onsitead_variant	string

Javascript

pa.sendEvent('publisher.impression', {
  'onsitead_type' : 'Publisher',
  'onsitead_advertiser' : 'Pitchfork',
  'onsitead_campaign' : '2',
  'onsitead_category' : 'HotDeals',
  'onsitead_creation' : 'brand',
  'onsitead_detailed_placement' : 'right',
  'onsitead_format' : '336x280',
  'onsitead_general_placement' : 'side',
  'onsitead_url' : 'https://www.atinternet.com',
  'onsitead_variant' : 'newbies',
});

Android (3.3.0+)

PianoAnalytics.getInstance().sendEvents(
  Event.Builder("publisher.impression")
    .properties(
      Property(PropertyName("onsitead_type"), "Publisher"),
      Property(PropertyName("onsitead_advertiser"), "Pitchfork"),
      Property(PropertyName("onsitead_campaign"), "2"),
      Property(PropertyName("onsitead_category"), "HotDeals"),
      Property(PropertyName("onsitead_creation"), "brand"),
      Property(PropertyName("onsitead_detailed_placement"), "right"),
      Property(PropertyName("onsitead_format"), "336x280"),
      Property(PropertyName("onsitead_general_placement"), "side"),
      Property(PropertyName("onsitead_url"), "https://www.atinternet.com"),
      Property(PropertyName("onsitead_variant"), "newbies"),
    )
    .build()
)

Android

pa.sendEvent(new Event("publisher.impression", new HashMap<String, Object>() {{
  put("onsitead_type", "Publisher");
  put("onsitead_advertiser", "Pitchfork");
  put("onsitead_campaign", "2");
  put("onsitead_category", "HotDeals");
  put("onsitead_creation", "brand");
  put("onsitead_detailed_placement", "right");
  put("onsitead_format", "336x280");
  put("onsitead_general_placement", "side");
  put("onsitead_url", "https://www.atinternet.com");
  put("onsitead_variant", "newbies");
}}));

Apple

pa.sendEvent(Event("publisher.impression", data: [
  "onsitead_type" : "Publisher",
  "onsitead_advertiser" : "Pitchfork",
  "onsitead_campaign" : "2",
  "onsitead_category" : "HotDeals",
  "onsitead_creation" : "brand",
  "onsitead_detailed_placement" : "right",
  "onsitead_format" : "336x280",
  "onsitead_general_placement" : "side",
  "onsitead_url" : "https://www.atinternet.com",
  "onsitead_variant" : "newbies"
]))

Flutter

await _pianoAnalytics.sendEvents(events: [
  Event(name: "publisher.impression", properties: [
    Property.string(name: "onsitead_type"), value: "Publisher"),
    Property.string(name: "onsitead_advertiser"), value: "Pitchfork"),
    Property.string(name: "onsitead_campaign"), value: "2"),
    Property.string(name: "onsitead_category"), value: "HotDeals"),
    Property.string(name: "onsitead_creation"), value: "brand"),
    Property.string(name: "onsitead_detailed_placement"), value: "right"),
    Property.string(name: "onsitead_format"), value: "336x280"),
    Property.string(name: "onsitead_general_placement"), value: "side"),
    Property.string(name: "onsitead_url"), value: "https://www.atinternet.com"),
    Property.string(name: "onsitead_variant"), value: "newbies"),
  ])
]);

HTTP

const site_id = `XXXXXXXXXX`;
const visitor_id = `<visitor_id>`;
const endpoint = `<xxxxxxx>.pa-cd.com`;

fetch(`https://${endpoint}/event?s=${site_id}&idclient=${visitor_id}`, {
  method: "POST",
  body: JSON.stringify({
    events: [{
      name: "publisher.impression",
      data: {
        "onsitead_type": "Publisher",
        "onsitead_advertiser": "Pitchfork",
        "onsitead_campaign": "2",
        "onsitead_category": "HotDeals",
        "onsitead_creation": "brand",
        "onsitead_detailed_placement": "right",
        "onsitead_format": "336x280",
        "onsitead_general_placement": "side",
        "onsitead_url": "https://www.atinternet.com",
        "onsitead_variant": "newbies"
      }
    }]
  })
})

Edit code sample

Internal search engine

Result display

Event name

internal_search_result.display

Standard properties

Property	Type
ise_keyword	string
ise_page	int

Javascript

pa.sendEvent('internal_search_result.display', {
  'ise_keyword' : 'daft',
  'ise_page' : 2,
});

Android (3.3.0+)

PianoAnalytics.getInstance().sendEvents(
  Event.Builder("internal_search_result.display")
    .properties(
      Property(PropertyName("ise_keyword"), "daft"),
      Property(PropertyName("ise_page"), 2),
    )
    .build()
)

Android

pa.sendEvent(new Event("internal_search_result.display", new HashMap<String, Object>() {{
  put("ise_keyword", "daft");
  put("ise_page", 2);
}}));

Apple

pa.sendEvent(Event("internal_search_result.display", data: [
  "ise_keyword" : "daft",
  "ise_page" : 2
]))

Flutter

await _pianoAnalytics.sendEvents(events: [
  Event(name: "internal_search_result.display", properties: [
    Property.string(name: "ise_keyword"), value: "daft"),
    Property.int(name: "ise_page"), value: 2),
  ])
]);

HTTP

const site_id = `XXXXXXXXXX`;
const visitor_id = `<visitor_id>`;
const endpoint = `<xxxxxxx>.pa-cd.com`;

fetch(`https://${endpoint}/event?s=${site_id}&idclient=${visitor_id}`, {
  method: "POST",
  body: JSON.stringify({
    events: [{
      name: "internal_search_result.display",
      data: {
        "ise_keyword": "daft",
        "ise_page": 2
      }
    }]
  })
})

Edit code sample

Result click

Event name

internal_search_result.click

Standard properties

Property	Type
ise_keyword	string
ise_click_rank	int
ise_page	int

Javascript

pa.sendEvent('internal_search_result.click', {
  'ise_keyword' : 'daft',
  'ise_click_rank' : 2,
  'ise_page' : 1,
});

Android (3.3.0+)

PianoAnalytics.getInstance().sendEvents(
  Event.Builder("internal_search_result.click")
    .properties(
      Property(PropertyName("ise_keyword"), "daft"),
      Property(PropertyName("ise_click_rank"), 2),
      Property(PropertyName("ise_page"), 1),
    )
    .build()
)

Android

pa.sendEvent(new Event("internal_search_result.click", new HashMap<String, Object>() {{
  put("ise_keyword", "daft");
  put("ise_click_rank", 2);
  put("ise_page", 1);
}}));

Apple

pa.sendEvent(Event("internal_search_result.click", data: [
  "ise_keyword" : "daft",
  "ise_click_rank" : 2,
  "ise_page" : 1
]))

Flutter

await _pianoAnalytics.sendEvents(events: [
  Event(name: "internal_search_result.click", properties: [
    Property.string(name: "ise_keyword"), value: "daft"),
    Property.int(name: "ise_click_rank"), value: 2),
    Property.int(name: "ise_page"), value: 1),
  ])
]);

HTTP

const site_id = `XXXXXXXXXX`;
const visitor_id = `<visitor_id>`;
const endpoint = `<xxxxxxx>.pa-cd.com`;

fetch(`https://${endpoint}/event?s=${site_id}&idclient=${visitor_id}`, {
  method: "POST",
  body: JSON.stringify({
    events: [{
      name: "internal_search_result.click",
      data: {
        "ise_keyword": "daft",
        "ise_click_rank": 2,
        "ise_page": 1
      }
    }]
  })
})

Edit code sample

MV Testing

Event name

mv_test.display

Standard properties

Property	Type
mv_creation	string
mv_test	string
mv_wave	int

Javascript

pa.sendEvent('mv_test.display', {
  'mv_creation' : 'BlueTheme',
  'mv_test' : 'NewUX',
  'mv_wave' : 2,
});

Android (3.3.0+)

PianoAnalytics.getInstance().sendEvents(
  Event.Builder("mv_test.display")
    .properties(
      Property(PropertyName("mv_creation"), "BlueTheme"),
      Property(PropertyName("mv_test"), "NewUX"),
      Property(PropertyName("mv_wave"), 2),
    )
    .build()
)

Android

pa.sendEvent(new Event("mv_test.display", new HashMap<String, Object>() {{
  put("mv_creation", "BlueTheme");
  put("mv_test", "NewUX");
  put("mv_wave", 2);
}}));

Apple

pa.sendEvent(Event("mv_test.display", data: [
  "mv_creation" : "BlueTheme",
  "mv_test" : "NewUX",
  "mv_wave" : 2
]))

Flutter

await _pianoAnalytics.sendEvents(events: [
  Event(name: "mv_test.display", properties: [
    Property.string(name: "mv_creation"), value: "BlueTheme"),
    Property.string(name: "mv_test"), value: "NewUX"),
    Property.int(name: "mv_wave"), value: 2),
  ])
]);

HTTP

const site_id = `XXXXXXXXXX`;
const visitor_id = `<visitor_id>`;
const endpoint = `<xxxxxxx>.pa-cd.com`;

fetch(`https://${endpoint}/event?s=${site_id}&idclient=${visitor_id}`, {
  method: "POST",
  body: JSON.stringify({
    events: [{
      name: "mv_test.display",
      data: {
        "mv_creation": "BlueTheme",
        "mv_test": "NewUX",
        "mv_wave": 2
      }
    }]
  })
})

Edit code sample

Batching similar events

You can batch multiple similar events into a single event: they will be split by our processing. To do this, push each event as an object into the array property named items_list. Properties at the root of the data object will be pushed to each event properties.

{
  "name": "product.display",
  "data": {
    "product_category1": "Hardware",
    "product_category2": "Computer",
    "product_category3": "Gaming",
    "product_category4": "Laptop",
    "items_list": [
      {
        "product_id":"LPTAX174", 
        "product": "Laptop AX174",
        "product_variant": "8Go RAM",
        "product_brand": "Laptop",
        "product_discount": false,
        "product_placement": "banner",
        "product_pricetaxincluded": 1399.9,
        "product_pricetaxfree": 1120.9,
        "product_stock": true
      },
      {
        "product_id":"LPTAX174", 
        "product": "Laptop AX174",
        "product_variant": "16Go RAM",
        "product_brand": "Laptop",
        "product_discount": false,
        "product_placement": "banner",
        "product_pricetaxincluded": 1499.9,
        "product_pricetaxfree": 1200.9,
        "product_stock": true
      }
   ]
  }
}

// equals to

[{
  "name": "product.display",
  "data": {
    "product_category1": "Hardware",
    "product_category2": "Computer",
    "product_category3": "Gaming",
    "product_category4": "Laptop",
    "product_id":"LPTAX174", 
    "product": "Laptop AX174",
    "product_variant": "8Go RAM",
    "product_brand": "Laptop",
    "product_discount": false,
    "product_placement": "banner",
    "product_pricetaxincluded": 1399.9,
    "product_pricetaxfree": 1120.9,
    "product_stock": true
  }
},
{
  "name": "product.display",
  "data": {
    "product_category1": "Hardware",
    "product_category2": "Computer",
    "product_category3": "Gaming",
    "product_category4": "Laptop",
    "product_id":"LPTAX174", 
    "product": "Laptop AX174",
    "product_variant": "16Go RAM",
    "product_brand": "Laptop",
    "product_discount": false,
    "product_placement": "banner",
    "product_pricetaxincluded": 1499.9,
    "product_pricetaxfree": 1200.9,
    "product_stock": true
  }
}]

note

You can send up to 100 items in the array. Please note that our Collection API has a payload size limit that may be reached before the 100 item limit. Please see the dedicated page.