1 of 1

Piano Analytics Collection API

Piano Analytics is the successor of AT Internet Analytics Suite 2 (AS2). It's a user-centric tool that simplifies product & marketing analytics, while ensuring data quality. Your data will be sent server-side getting the most from Piano Analytics' Collection API and in form of events.

The Collection API is only available for Piano Analytics. You can check the following compatibility table to get more insights on supported features by product.

Key features

The Piano Analytics Collection API destination provides the following key features:

Events structure: our matches , meaning that your data is properly bridged to the expected fields in an optimized way.
Prebuilt mappings: data mapping for event-based destinations happens automatically, which simplifies user inputs.
Custom events: you can freely push custom events based on your specific needs.

Destination setup

Before you get started with this destination, ensure you have access to .

The client-side unique visitor identifier is recommended and is retrieved by getting the value of the , , , or xtidc cookie in this priority order.

Configuration

Settings

Description

[1] This feature allows you to set an event property holding a dynamic value by adding two open braces ( {{ ) in front of your property name and two close braces ( }} ) at the end (E.g. {{myEventPropertyPathAndName}} ). [2] Using "dots" (".") you can navigate deeper to the specific field you want to get the value of. See for more details on the standard field names by event. You can also freely set custom fields: there are no boundaries.

Quick reference

events are supported by .

Commanders Act Events

Piano Analytics Events

[*] Custom events must be added to the Piano Analytics' data model first or they won't be processed. You can add new events by following ➜ SETTINGS ➜ Data Management ➜ Data Model ➜Events. [1] If page_type is equal to product then product.page_display

Field mappings

Commanders Act Properties

Piano Analytics Properties

[1] The timestamp related to when the event took place. Both 10 or 13-digit timestamps are supported: with the latter, the timestamp is converted in the decimal format (E.g. 1756195156953 is set as 1756195156.953 ). You can also directly set the decimal format with 13-digit timestamps. [2] Field included for the following events: add_to_cart , page_view (product.page_display) , view_item , purchase (product.purchased)

Headers parameters

Commanders Act Properties

Piano Analytics Fields

Autopromo events

When sending and click.action events, you can add autopromotions, by setting the array field autopromos . See the following example:

Each position in the array needs to include a valid Piano Analytics event and is forwarded as it's. In the above example, two additional events are included in a single request to Piano Analytics. This feature needs to be activated in the "Advanced Setting" by flagging the "Send Autopromo Events" option - See for more details.

Piano Analytics Collection API

The Collection API is only available for Piano Analytics. You can check the following compatibility table to get more insights on supported features by product.

Key features

The Piano Analytics Collection API destination provides the following key features:

Events structure: our matches , meaning that your data is properly bridged to the expected fields in an optimized way.
Prebuilt mappings: data mapping for event-based destinations happens automatically, which simplifies user inputs.
Custom events: you can freely push custom events based on your specific needs.

Destination setup

Before you get started with this destination, ensure you have access to .

The client-side unique visitor identifier is recommended and is retrieved by getting the value of the , , , or xtidc cookie in this priority order.

Configuration

Settings

Description

[1] This feature allows you to set an event property holding a dynamic value by adding two open braces ( {{ ) in front of your property name and two close braces ( }} ) at the end (E.g. {{myEventPropertyPathAndName}} ). [2] Using "dots" (".") you can navigate deeper to the specific field you want to get the value of. See for more details on the standard field names by event. You can also freely set custom fields: there are no boundaries.

Quick reference

events are supported by .

Commanders Act Events

Piano Analytics Events

[*] Custom events must be added to the Piano Analytics' data model first or they won't be processed. You can add new events by following ➜ SETTINGS ➜ Data Management ➜ Data Model ➜Events. [1] If page_type is equal to product then product.page_display

Field mappings

Commanders Act Properties

Piano Analytics Properties

[1] The timestamp related to when the event took place. Both 10 or 13-digit timestamps are supported: with the latter, the timestamp is converted in the decimal format (E.g. 1756195156953 is set as 1756195156.953 ). You can also directly set the decimal format with 13-digit timestamps. [2] Field included for the following events: add_to_cart , page_view (product.page_display) , view_item , purchase (product.purchased)

Headers parameters

Commanders Act Properties

Piano Analytics Fields

Autopromo events

When sending and click.action events, you can add autopromotions, by setting the array field autopromos . See the following example:

Custom Event Properties

Map your custom event properties by setting their field names in Piano Analytics property name and adding the field name holding the value in Your event property . E.g. if you input size in the Piano Analytics property name and items.0.product.size in Your event property , you'll have a custom event property in Piano Analytics called size with a value based on the content of the field items.0.product.size [2].

In the column Your event property path you should keep the default value Default (root) as it better fits most scenarios. In case you select either

Custom User Properties

Map your custom user properties by setting their field names in User property name and adding the field name holding the value in Commanders Act event property or static value . E.g. if you input customer_zipcode in User property name and user.zipcode [2] in Commanders Act event property or static value , you will have a custom user property in Piano Analytics called customer_zipcode with a value based on the content of the field user.zipcode . You also have the option to set a static string/numeric value in Commanders Act event property or static value .

To ensure that custom user properties are picked up by Piano Analytics, you need to create them first by following ➜ SETTINGS