1 of 100

Destinations

Check out the Destinations catalog if you merely want to look at the Commanders Act destinations and how each is implemented.

Sources vs Destinations

The platform has Sources and Destinations. Sources send data into the platform, while Destinations receive data from the platform.

Destinations overview

Destination list

Find here the full list of already configured.

You can search a destination by name and filter on environment (production or staging), status (active or inactive) or on specific source.

4 sections are available: Cloud mode, Device mode, Audience and Raw Data.

Cloud mode

It refers to event based destinations that execute on the server (aka server-side tags): destinations that run in real-time and push your events (purchases, page views...).

Device mode (soon)

It refers to destinations that needs to be executed in the browser (aka client-side tags). For example : survey tag, A/B testing, heatmapping tool, live chat, web notification, ... Currently, client-side tags are manageable in the web containers section. They will move progressively on the device mode section.

Audience

It refers to destinations that push user's segments, each time a user enter or leave a segment you created.

Raw Data

It refers to scheduled destinations, through file exchange like FTP, S3 or Cloud Storage.

Trend and Health

The trend represents the evolution of number of events pushed to the destination on the last month (maximum data retention period).

Automatic Audience replay

For realtime audience based destination

Introduction

The "Automatic Audience Replay" feature is designed to enhance dynamic segments usage within real-time audience-based destinations like Facebook Custom Audiences.

Background

In our previous system, for real-time audience-based destinations, only users who joined a segment after the creation of the destination were automatically sent to that destination. This approach overlooked users who were already in the segment. The Audience Replay feature rectifies this by ensuring that all segment users, both existing and new, are sent to the relevant destination.

The Audience Replay Feature

Simplified Process

When Creating a Destination:
- Immediate Activation: If the destination is activated immediately, an operation is launched to send all users from the segment to the destination without delay.
- Scheduled Activation: For destinations set to activate later, an operation is scheduled to send all users in the segment to the destination at the specified start time.
When Updating a Destination:
- Reactivation/Modification: Some updates to the destination (changing start times or timezones) automatically initiates an operation to send all segment users to the updated destination.
- Adding New Segments: Incorporating new segments into the destination triggers an operation to send only the users from these new segments.

Supported Destinations

This feature works seamlessly with various real-time, audience-based destinations, including:

Facebook Custom Audiences
Google Customer Match
Criteo Audiences
Google Ads Customer Match
Rakuten
Google DDP

Benefits

Comprehensive User Engagement: Ensures every historical relevant user in the segment is sent to the destination, enhancing audience coverage.
Efficient Automation: Reduces manual efforts and error potential, streamlining the process of managing audience data.
Current and Relevant Audience Data: Keeps your audience segments up-to-date, maximizing the impact of your marketing efforts.

Destinations catalog

Find here the list of all plug&play destinations.

Destinations are sorted per categories (Advertising, Emailing, Analytics, Push notifications...).

The destination's catalog homepage show an overview of 3 destinations per categories, click on the categories menu or on 'View all' to display the full destinations list. You didn't find the destination you were looking for? Do not hesitate to fill the request form to ask our team to add a new destination on the list, or use the Destination Builder

Newly added destinations are summarized on the New tab.

Flags meanings:

"New": the destination was just released
"Closed alpha": the destination is not open publicly, the backend is still in QA on our side (Commanders Act tests) and/or the partner.
"Beta" : the destination is usable by everybody, but it has to be validated with one ore more first (beta) customers

You need more information about a destination? Simply click on it, and you will have access to all details and requested settings for this destination.

AbTasty

1- Audience configuration

Select 1 or many segment(s) you want to export.

Select what kind of data you want to export:

Users
Page views
Conversions
Products
Views (only available for Campaign Analytics customers)
Clicks (only available for Campaign Analytics customers)

Select properties you want to export.

You can add also a static column, meaning you can set a value, and it will be exported as you entered it.

Select the data range:

All: all stored data corresponding to what you selected
Pick up where last export left off: differential export, you can export only records which were not exported on the last export
Last... / Between...: select a precise period for the data range

2- Settings

Select the storage connector (a storage connector can be configured on Administration / Connector credentials).

Precise the filename and extension (CSV by default).

Precise if you want to compress the file (GZIP by default).

Precise if you want to include headers at the top of the file.

Precise the main separator and separator inside a variable (ex: value1,value2;value2a;value2b,value3)

Actito

1- Audience configuration

Select 1 or many segment(s) you want to export.

Select what kind of data you want to export:

Users
Page views
Conversions
Products
Views (only available for Campaign Analytics customers)
Clicks (only available for Campaign Analytics customers)

Select properties you want to export.

You can add also a static column, meaning you can set a value, and it will be exported as you entered it.

Select the data range:

All: all stored data corresponding to what you selected
Pick up where last export left off: differential export, you can export only records which were not exported on the last export
Last... / Between...: select a precise period for the data range

2- Settings

Select the storage connector (a storage connector can be configured on Administration / Connector credentials).

Precise the filename and extension (CSV by default).

Precise if you want to compress the file (GZIP by default).

Precise if you want to include headers at the top of the file.

Precise the main separator and separator inside a variable (ex: value1,value2;value2a;value2b,value3)

Adform

is a global digital media advertising technology company specializing in real-time programmatic marketing automation technologies. Using this destination you can implement .

Key features

The Adform destination provides the following key features:

Events structure: our covers , 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.
Smart mapping: data mapping can be readjusted using your datalayer defined fields.
Support for multi-item data: information included in the array is bridged to Partnerize.

Destination setup

A client-side tag template named "Adform - Get 3rd Party Cookie ID" is available in our library to help you retrieve the Adform Third-Party Identifier. Use to refine events and/or other properties matching your specific needs.

Configuration

Settings

Description

Quick reference

Field mappings

Most properties can be remapped using our "Smart Mapping" feature. For audience building and retargeting, make sure to pass a user identifier. Geo and device information come from the provided user ip and agent. Adform standard attribution works only if identity.cookieId (Adform 3rd party cookie) or identity.advertisingId (mobile advertising ID) is passed correctly. Adform Cookieless Insights reporting is enabled by passing values in both userContext.userAgent and userContext.userIp .

Adobe

Adobe is an multinational computer software and web analytics company (See Adobe Experience Cloud).

Adobe Analytics

is an multinational computer software and web analytics company (See ). Using this destination you can implement server-side tracking, by sending events to Adobe Analytics.

Please note that we use the Adobe .

Authentication

We use the Oauth2 authentication process.

Only the server-to-server oauth is supported

Go to Administration / Connector Credentials and click on Add connector credentials. Select Adobe Analytics.

Enter the Client ID and Client Secret that you can find on your Adobe Developer Console.

In case you haven’t selected the server-to-server oauth (if it is an old project, and you don’t want to configure it again for example), it is possible to change the authentication, click on “Connect another credential” on Adobe Analytics interface.

Configuration

Click on Destinations / Add destination and select Adobe Analytics on the catalog.

Select sources, give a name to the destination and select the environment.

Select the authentication you've just created previously.

Fill the Adobe Group ID and Customer ID Type coming from your Adobe Analytics account.

Mandatory parameters mapping

This parameter is mandatory:

userAgent

You can map corresponding properties or directly enter values.

User id mapping

At least one of these fields should be filled to identify users.

visitorID
marketingCloudVisitorId
IP address
CustomerID (CustomerIDType)

Page identifier mapping

Adobe web page identifier. You can set several, but at least one is needed for the export. If you set either linkName, linkURL or linkType the other two must be set as well.

Mapping

You can map here all your event properties to Adobe Analytics properties, especially eVars.

Properties transformation

This step is optional, you can transform your properties before to send it.

Adobe Campaign

Adobe is an multinational computer software and web analytics company (See Adobe Experience Cloud).

1- Audience configuration

Select 1 or many segment(s) you want to export.

Select what kind of data you want to export:

Users
Page views
Conversions
Products
Views (only available for Campaign Analytics customers)
Clicks (only available for Campaign Analytics customers)

Select properties you want to export.

You can add also a static column, meaning you can set a value, and it will be exported as you entered it.

Select the data range:

All: all stored data corresponding to what you selected
Pick up where last export left off: differential export, you can export only records which were not exported on the last export
Last... / Between...: select a precise period for the data range

2- Settings

Select the storage connector (a storage connector can be configured on Administration / Connector credentials).

Precise the filename and extension (CSV by default).

Precise if you want to compress the file (GZIP by default).

Precise if you want to include headers at the top of the file.

Precise the main separator and separator inside a variable (ex: value1,value2;value2a;value2b,value3)

AdRoll

1- Audience configuration

Select 1 or many segment(s) you want to export.

Select what kind of data you want to export:

Users
Page views
Conversions
Products
Views (only available for Campaign Analytics customers)
Clicks (only available for Campaign Analytics customers)

Select properties you want to export.

You can add also a static column, meaning you can set a value, and it will be exported as you entered it.

Select the data range:

All: all stored data corresponding to what you selected
Pick up where last export left off: differential export, you can export only records which were not exported on the last export
Last... / Between...: select a precise period for the data range

2- Settings

Select the storage connector (a storage connector can be configured on Administration / Connector credentials).

Precise the filename and extension (CSV by default).

Precise if you want to compress the file (GZIP by default).

Precise if you want to include headers at the top of the file.

Precise the main separator and separator inside a variable (ex: value1,value2;value2a;value2b,value3)

Adition

1- Audience configuration

Select 1 or many segment(s) you want to export.

Variables are automatically added:

Adition user ID (ID coming from the cookie sync with Adition)
Segment public IDs (IDs of segments to which selected users belongings)

Select the data range:

All: all stored data corresponding to what you selected
Pick up where last export left off: differential export, you can export only records which were not exported on the last export
Last... / Between...: select a precise period for the data range

2- Settings

Select the storage connector (a storage connector can be configured on Administration / Connector credentials).

Network ID: ID coming from Adition account

3- Activation

Define the running frequency for the export (every 10 minutes, day, week...)

Adventori

1- Audience configuration

Select 1 or many segment(s) you want to export.

Select what kind of data you want to export:

Users
Page views
Conversions
Products
Views (only available for Campaign Analytics customers)
Clicks (only available for Campaign Analytics customers)

Select properties you want to export.

You can add also a static column, meaning you can set a value, and it will be exported as you entered it.

Select the data range:

All: all stored data corresponding to what you selected
Pick up where last export left off: differential export, you can export only records which were not exported on the last export
Last... / Between...: select a precise period for the data range

2- Settings

Select the storage connector (a storage connector can be configured on Administration / Connector credentials).

Precise the filename and extension (CSV by default).

Precise if you want to compress the file (GZIP by default).

Precise if you want to include headers at the top of the file.

Precise the main separator and separator inside a variable (ex: value1,value2;value2a;value2b,value3)

Affilae

Affilae provides complete affiliate marketing solutions to manage your partnership strategies. Using this destination you can enable server-side tracking.

Key features

The Affilae destination provides the following key features:

Events structure: our Events reference matches Affilae conversion tracking, 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.
Smart mapping: data mapping can be readjusted using your datalayer defined fields.
Support for multi-item data: information included in the item array is dispatched to Affilae.

Destination setup

Configuration

Settings

Description

Key

Required Your key as provided by Affilae on the "conversion code" page through your affiliate program configuration dashboard.

Click Id

Required The click identifier is automatically generated by Affilae when users click on affiliate links: it's set in the landing URL through the aecid parameter.

Revenue Share Id

Your client identifier if the Revenue Share option is activated. Please use an identifier that will not change over time, the best being the identifier number used in your database. Leave this empty if you do not use the Revenue Share option.

Quick reference

Commanders Act Events

Affilae Tracking

[Any Event] [1]

[Any Conversion]

[1] Use Destination filters to specify your matching events.

Field Mappings

Most properties can be remapped using our "Smart Mapping" feature.

Commanders Act Properties

Affilae Properties

Key

key [*]

Click Id

cids [*]

id

id [*]

currency

currency [*]

revenue

amount

payment_method [1]

type [2]

payment

Revenue Share Id

customer

partners.affilae.cv

cv

coupon

voucher

items.X.id

product [3]

[*] Mandatory property. [1] Supported values: by_bank_transfer_in_advance and online_payment_system . [2] Supported values: online , offline and call . [3] product identifiers are separated by semicolons (;).

Alphalyr Marketing Studio

Alphalyr helps you boosting your omnichannel commerce with the data that matters. Using this destination you can connect your activities and events with Alphalyr Marketing Studio.

Key features

The Alphalyr Marketing Studio destination provides the following key features:

Events structure: our Events reference supports Alphalyr's page types, 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.
Automatic hashing: information is automatically hashed matching partner specifications.
Smart mapping: data mapping can be readjusted using your datalayer defined fields.
Support for multi-item data: information included in the item array is bridged to Rakuten Advertising.

Destination setup

Configuration

Settings

Description

Client Public Key

Required Your unique public key as given by Alphalyr Marketing Studio. This setting supports dynamic values [1].

Customer Type

Defines your customer type. Takes the value 0 when it is an old client and 1 when it is a new one. This setting supports dynamic values [1].

User Unique Identifier (UUID)

UUID value of the user's cookie. Following the latest updates to the ITP protocol on Safari / iOS, Alphalyr strongly recommends that you use a "server" cookie coming directly from your first party domain. This setting supports dynamic values [1].

Custom Data

Additional data that can be added for custom data processing. This setting supports dynamic values [1].

Is SPA

Whether your website is a Single Page Application.

GDPR Consent

GDPR consent. It takes the value 1 when GDPR applies or 0 otherwise. This setting supports dynamic values [1].

Consent Status for Ads & Marketing

Consent status for ads & marketing. It takes the value 1 if the user has consented to the use of his data for targeting and marketing or 0 otherwise. This parameter is transmitted to Alphalyr's partners. This setting supports dynamic values [1].

Consent Status for Performance

Consent status for performance. It takes the value 1 if the user has consented to the use of his data for the measurement of performance measurement or 0 otherwise. This parameter is transmitted to Alphalyr's partners. This setting supports dynamic values [1].

Quick reference

Use Destination filters to specify your matching events.

Commanders Act Events

Alphalyr Page Types

purchase

view_cart

cart

view_item

product

view_item_list

category

[Any Other Event]

home

Field Mappings

Most properties can be remapped using our "Smart Mapping" feature.

Commanders Act Properties

Alphalyr Properties

(event_name)

page [1]

Client Public Key

aid

user.email_md5

cid

User Unique Identifier (UUID)

user.consistent_anonymous_id

uuid [2]

context.page.referrer

referrer

context.device.ip

ip_address [3]

context.device.user_agent

user_agent

(eventModel.app.name)

deviceType [4]

context.page.url

path [5]

items.X.id

prodId [6]

items.X.product.name

prodDescription [6]

items.X.product.price

prodPrice [6]

item_list_id

catId [7]

item_list_name

catDescription [7]

items.X.id:items.X.quantity:items.X.product.price

products [8][9]

currency

currency [9]

revenue

value

totalPrice [9][10]

value

totalPriceWithTax [11]

shipping_amount

shippingPrice [11]

id

reference [11]

Customer Type

new [11]

coupon

discountCode [11]

items.X.discount

discountAmount [8][11]

Custom Data

customData [11]

GDPR Consent

gdpr_consent

Consent Status for Ads & Marketing

consent_ads

Consent Status for Performance

consent_performance

context.device.lifecycle.session_id

gaSessionId [12]

[1] See Quick reference for more details. [2] Field automatically hashed with SHA256 if passed in clear. Priority order is provided on the left column. [3] Field anonymized. [4] This is either m or d depending if eventModel.app.name is set or not. [5] The pathname part of context.page.url is set: additional parameter are added to the request based on searchParams (See URL object for more details). [6] For Alphalyr product page type only. [7] For Alphalyr category page type only. [8] All items are taken into account. [9] For Alphalyr purchase and cart page type only. [10] Depending if Alphalyr page type is purchase or cart then revenue or value is used respectively. [11] For Alphalyr purchase page type only. [12] When Is SPA is flagged only.

Amazon

Amazon is a multinational technology company focusing on e-commerce, cloud computing, online advertising, digital streaming, and artificial intelligence.

Amazon Ads Conversions API

Amazon is a multinational technology company focusing on e-commerce, cloud computing, online advertising, digital streaming, and artificial intelligence. Using this destination you can import conversion event data in Amazon DSP.

Key features

The Amazon Ads Conversions API destination provides the following key features:

Events structure: our Events reference model matches Amazon's conversion definitions/types, 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.
Automatic hashing: information is automatically hashed matching partner specifications.
Smart mapping: data mapping can be readjusted using your datalayer defined fields.

Destination setup

Configuration

Settings

Description

Authentication

Required Your credentials with Amazon Ads as set in the Commanders Act interface following: Administration ➜ Connector Credentials ➜ Add connector credentials ➜ AmazonAds

API Base Url

Advertiser Id

Required Your account identifier you use to access the DSP. This is your DSP Advertiser ID. DSP Entity ID is not supported.

Profile Id

Required Select your profile identifier.

Conversion Definition Id

Required Select your conversion definition identifier.

Country

Quick reference

Commanders Act Events

Amazon Tracking

[Any Event] [1]

[Any Conversion Definitions/Types] [2]

[1] Use Destination filters to specify your matching events. [2] See Conversion Definition Id in Configuration for more details.

Field Mappings

Most properties can be remapped using our "Smart Mapping" feature. All Amazon properties are include in eventData.0 .

At least one identifier must be provided in matchKeys .

Commanders Act Properties

Amazon Properties

Country

countryCode [*]

event_name

name [*]

context.event_timestamp

timestamp [*]

Conversion Definition Id

conversionDefinitionId [*]

user.email_sha256

user.phone

user.firstname

user.lastname

user.street

user.city

user.state

user.zipcode

context.device.advertising_id

matchKeys.X.values[0] [1]

(user.email_sha256

user.phone

user.firstname

user.lastname

user.street

user.city

user.state

user.zipcode

context.device.advertising_id)

matchKeys.X.type [2]

items.length

unitsSold

value

currency

currencyCode

context.event_id

clientDedupeId [3]

partners.amazon.data_processing

dataProcessingOptions [4]

[*] Mandatory property. [1] At least one identifier must be provided. [2] Depending on the value provided in matchKeys.X.values[0] , this is one of the following values: EMAIL, PHONE, FIRST_NAME, LAST_NAME, ADDRESS, CITY, STATE, POSTAL or MAID. [3] The client specified id for the conversion event. For events with the same clientDedupeId only the latest event will be kept. [4] This is set with with LIMITED_DATA_USE when partners.amazon.data_processing is a non-empty string, non-false (boolean), non-zero (number) value.

Amazon S3

1- Audience configuration

Select 1 or many segment(s) you want to export.

Select what kind of data you want to export:

Users
Page views
Conversions
Products
Views (only available for Campaign Analytics customers)
Clicks (only available for Campaign Analytics customers)

Select properties you want to export.

You can add also a static column, meaning you can set a value, and it will be exported as you entered it.

Select the data range:

All: all stored data corresponding to what you selected
Pick up where last export left off: differential export, you can export only records which were not exported on the last export
Last... / Between...: select a precise period for the data range

2- Settings

Select the storage connector (a storage connector can be configured on Administration / Connector credentials).

Precise the filename and extension (CSV by default).

Precise if you want to compress the file (GZIP by default).

Precise if you want to include headers at the top of the file.

Precise the main separator and separator inside a variable (ex: value1,value2;value2a;value2b,value3)

Attraqt

Documentation in progress.

Awin

provides a global affiliation network connecting businesses with customers. Using this destination you can implement using the same .

Awin no longer support the use of pixel only implementations due to various browser constraints and limitations.

Key features

The Awin destination provides the following key features:

Events structure: our covers , 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.
Smart mapping: data mapping can be readjusted using your datalayer defined fields.
Support for multi-item data: information included in the array is bridged to Awin.
Commission group: remunerate different products based on your .

Destination setup

The parameter is appended to the landing page URL by Awin to identify the source of the click. This value is mandatory and is retrieved by getting the value of either the Click Id (See ) or the cookie, in this priority order.

Configuration

Settings

Description

Quick reference

Field mappings

Most properties can be remapped using our "Smart Mapping" feature. The following fields are mandatory to properly set commission groups: - items.X.affiliation - items.X.product.price - items.X.quantity

Accepted characters for the commission group codes are alphanumerics and letter in upper case, underscore (_) , point (.) and minus (-).

Batch Audience

This destination is currently under final review and will be available soon.

Batch lets CRM Teams design, test and automate their customer engagement strategies to keep users engaged and grow revenue. Using this destination you can share audiences with Batch by leveraging the Custom Audience API 1.1.

Audiences are synchronized using their names as identifier. Avoid renaming to maintain consistency.

Key features

The Batch Audience destination provides the following key features:

Audience sharing: our Events reference model drives audience sharing with Batch, meaning that you can synchronize your existing user segments, with your partner, in a seamless way.

Destination setup

Configuration

Settings

Description

Batch API Key

REST API Key

Custom User Id

Custom Audience Properties Mapping

Custom Audience Properties Tags

Field mappings

Created segments include the following properties:

Property Name

Property Value

name

context.segment_name

description

context.site_id_context.segment_id_context.segment_name

type

custom_ids

nb_ids

(Number of identifiers in segment)

indexing_state

APPLIED

created

(Creation time in the format YYYY-MM-DDTHH:MM:SS)

updated

(Update time in the format YYYY-MM-DDTHH:MM:SS)

Branch Events

(formerly known as Branch Metrics) is a mobile software company focused on mobile deep linking and attribution. This integration allows .

Key features

The Branch Events destination provides the following key features:

Events structure: our matches Branch and , 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.
Refined data: you can freely push additional information based on your specific needs (E.g. adding custom events and custom event properties).
Smart mapping: data mapping can be readjusted using your datalayer defined fields.
Event mapping: change standard mapping between your partners' events and yours or add new mappings.
Support for multi-item data: information included in the array is dispatched to Branch.

Destination setup

Before configuring this destination, you need to create a .

Configuration

Settings

Description

Quick reference

Field Mappings

At least one of the following must be included: • developer_identity • browser_fingerprint_id • idfa OR idfv (IF os = iOS ) • aaid OR android_id (IF os = Android )

Most properties can be remapped using our "Smart Mapping" feature.

[1] in user_data . [2] in event_data . [3] in content_items.X . [4] in items.X . [5] property set when context.device.os.name is iOS (case insensitive). [6] property set when context.device.os.name is Android (case insensitive). [7] boolean opposite of context.device.ad_tracking_enabled .

Campaign Analysis Legacy

Only for Campaign Analysis Module (ex Mix Commander) customers

Introduction

This destination allows you to collect events and map it for the module Campaign Analysis It can also turns events from Normalized Datalayer into touchpoints for Campaign Analysis module.

With this destination, you can use 4 standard events. To receive events in this destination, it requires as event name the 'Standard event name' described in the following array. Here's the list of Campaign Analytics touch points names vs Standard events names:

Campaign Analysis touch point

Standard event name

If you need more information about these events, check the section

How to implement

1/Select Campaign Analysis Legacy in the destination catalog.

2/Choose your data source(s)

3/Name your destination and select an environment

4/Setup your dimensions.

This destination will do an automatic mapping between the Campaign dimensions and the Standard properties. Here's the list of the automatic configuration done by this destination:

If you use custom properties, or if you want to modify one or some of theses campaign dimensions with another property then the ones listed above, you will have to use the mapping table.

In all cases, a hand mapping is possible (between dimensions and properties). It will take the priority and override native mapping. Use the mapping table menu to make your own correspondence table:

If you add a new custom dimension in your Campaign Analytics, you must to declare it manually also in this table of the destination's settings

If you do not want to use automatic mapping of dimensions with event properties, you can check the option "disable automatic configuration"

This action will block all automatic mapping between Campaign dimensions and Standard properties

Before to send your events to this destination you can, if needed, transform them to rename or remove some properties. Enter on the left the property name you want to add, delete or modify. Then enter on the right the property name where the value stands (or leave empty to remove the property)

6/Setup your filters - create your event(s) specification

You have to specify which event is concerned by this destination. Here's an example for a purchase (orders)

Don't forget to setup a consent filter to be RGPD compliant as well

7/Your destination is ready to be activated!

8/Go Further: modify timestamp

ts_override property can be used to change the timestamp of an event

Example:

https://collect.commander1.com/events?tc_s={site_id}}&token={token}&medium=seo&source=google&ts_override=1716888588&event_name=ad_click&campaign=sales_2024

Commission Junction

(CJ) provides a global affiliation network connecting businesses with customers. Using this destination you can implement server-side tracking.

Key features

The Commission Junction destination provides the following key features:

Events structure: our covers Commission Junction server-side tracking, 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.
Smart mapping: data mapping can be readjusted using your datalayer defined fields.
Refined data: you can freely push additional information based on your specific needs.
Support for multi-item data: information included in the array is bridged to Awin.

Destination setup

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 property 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.

Field mappings

Criteo

is an advertising company that provides online display advertisements.

Criteo - Events

is an advertising company that provides online display advertisements. Using the you can track web events you are used to report via . This is normally required for technical and legal reasons.

Key features

The Criteo (events) destination provides the following key features:

Events structure: our suits , 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.
Refined data: you can freely push additional information based on your specific needs (E.g. adding custom events, custom event and user properties).
Support for multi-item data: information included in the array is brought to Criteo.

Destination setup

The is required: this value must be passed to this destination by including the cookie crto_mapped_user_id. The easiest way to manage this cookie is to use this client-side tags in our tag library : Criteo - User Identification in your web container.

Configuration

Settings

Description

Quick reference

Commanders Act Events

Criteo Events

[1] If page.type is home then viewHome is also sent with viewPage, otherwise, just viewPage is forwarded.

Field mappings

Criteo (audiences)

is an advertising company that provides online display advertisements. Create a segment on DataCommander to build your audience. Then, you can push this audience to Criteo through our connector Criteo (audiences).

You need first to accept a consent link send by our consultants. This link is needed to authorize our DataCommander Criteo App to have access to your Criteo account to push audiences.

Then you can configure the connector, select the segment you created just before and simply enter your Criteo Advertiser ID (you can find it on your Criteo account).

Click on SAVE and it will automatically create a new audience (user list) on Criteo side.

Criteo (offline conversions)

is an advertising company that provides online display advertisements. Push your offline conversions, like purchases made in physical stores, directly to Criteo.

Store ID variable:

You must specify the Store ID variable, the variable corresponding to the store identifier on your conversions.

Offline conversions filter:

By default, we apply a filter on conversion_type = 'offline' to push only offline conversions. However, if you have a specific setup, you can change this value if needed.

Criteo Account ID:

Enter your Criteo Account ID, you can find it directly on Criteo interface.

Data Activation Legacy

Only for advanced users

This destination is temporary, it is the first step of the migration to support events format in Data Activation module

Map events collected to Data Activation format (previously called Data Commander format). The goal is to collect events and map it to Data Activation format to be able to use the segmentation, audience connectors, augmented user attributes...

Select Data Activation Legacy on the destination catalog.

On the settings page, you can find the mapping:

Step 1: Data Activation Variable ← Event property mapping

Select on the left a Data Activation variable (user_email ; user_id...) and map it to the corresponding event's property (user.email ; value...).

You can use a static value, please enter it between quotation marks “ “.

Step 2: Data Activation page type (env_template variable) ← Event name mapping

This mapping is dedicated for env_template variable.

On the left, enter the env_template variable corresponding to the page type and map it to the event name (ex: funnel_confirmation ⇒ purchase).

Step 3: additional mapping, ONLY for page_view event

Only for page view event, map the env_template variable corresponding to the page type to the page type in page view event (ex: productpage ⇒ product).

Step 4: Advanced options

Purchase event to Data activation conversion universe

If you check the box, purchase events will be stored on Data activation conversion storage.

Items mapping

If you check the box, you can define the mapping between product variables and items properties in event.

First, select the variable corresponding to the product list. Then, map the product variable to the item property in the event.

Dataventure

This destination is currently under final review and will be available soon.

Destination Logs Exporter (closed beta)

You can easily export your destination's raw logs using the Destination Logs Exporter. This destination will allow you to export to an SFTP all outgoing requests issued by the destinations you choose, and to analyze in these logs all the details, including the originating events that led to the outgoing requests.

Configuration

Data Source

Select one or more destinations from which you'd like to export your data.

Settings

Name your destination and pick the environment you'd like to work in.
Select a storage connector. This can be set up in Administration > Connector Credentials. Only FTP, Amazon S3 & Google Cloud Storage are currently supported
Specify the file name and extension (default is CSV).
By default, your export file will not be compressed. If needed, you can compress your file to GZIP format.
Set the data separator, like commas for CSV files (e.g., value1,value2).

Activation

Enable your destination to start exporting!
Modify the timezone if necessary.
Adjust the export frequency and time window to suit your needs.

Dialog-Mail

1- Audience configuration

Select 1 or many segment(s) you want to export.

Select what kind of data you want to export:

Users
Page views
Conversions
Products
Views (only available for Campaign Analytics customers)
Clicks (only available for Campaign Analytics customers)

Select properties you want to export.

You can add also a static column, meaning you can set a value, and it will be exported as you entered it.

Select the data range:

All: all stored data corresponding to what you selected
Pick up where last export left off: differential export, you can export only records which were not exported on the last export
Last... / Between...: select a precise period for the data range

2- Settings

Select the storage connector (a storage connector can be configured on Administration / Connector credentials).

Precise the filename and extension (CSV by default).

Precise if you want to compress the file (GZIP by default).

Precise if you want to include headers at the top of the file.

Precise the main separator and separator inside a variable (ex: value1,value2;value2a;value2b,value3)

Dynamic Yield

helps businesses deliver digital customer experiences that are personalized, optimized, and synchronized. This destination leverages the to track , so you can use the information for behavioral targeting, reporting, setting optimization goals, recommendations, and audience building.

Key features

The Dynamic Yield destination provides the following key features:

Events structure: our covers , 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.
Refined data: you can freely push additional information based on your specific needs (E.g. adding custom events and custom event properties).
Automatic hashing: information is automatically hashed matching partner specifications.
Smart mapping: data mapping can be readjusted using your datalayer defined fields.
Send all properties: send all your event properties to Dynamic Yield with a single click.

Destination setup

Use to refine events and/or other properties matching your specific needs.

Configuration

Settings

Description

Quick reference

Field Mappings

Most properties can be remapped using our "Smart Mapping" feature.

Facebook Conversions API

Aka Facebook CAPI

Facebook is an online social media and social networking service owned by Meta. This destination allows you to push every kind of event directly to Facebook through API: by sending online and offline conversions to you can increase the reach and accuracy of your campaigns.

You can, for example, not send campaigns related to a specific product to users who already bought it, or you can also send campaigns to users who bought a specific product in cross-sell logic.

How to send events to Facebook?

Facebook developed an API called 'Facebook Conversions API' https://developers.facebook.com/docs/marketing-api/conversions-api

You need a Facebook Business Manager account https://business.facebook.com/

Then on the menu, click on 'Events Manager':

Here you have to create a new Web Pixel:

Select Conversions API and give a name to your connection:

Now your pixel is created and you will have access to the IDs needed on our connector.

Where can I find the Pixel ID?

You need to fill the pixel ID on our connector, it is the ID of the pixel you just created on steps above.

You can find this ID when you click on the pixel's name and on the right of the graph activities. You can find it also on the settings tab.

You can now copy and paste this ID on our connector.

Then you need the Access Token

Where can I find the access token?

Click on the settings tab.

Scroll until the section 'Conversions API'

Click on the button 'Create Access Token':

If you are not able to click on the button 'Create access token', that mean you don't have enough rights to do it. You should be administrator on your Facebook Business account to create it.

Then you can copy and paste the Access Token on our connector.

How to manage consents?

Only events with a consent will be sent to Facebook
Only conversions with personal information (email and/or phone number...) will be sent to Facebook

For customers with our product TRUST Commander:

TRUST Commander is our Consent Management Platform. (More information: https://www.commandersact.com/en/solutions/trustcommander/)

On the connector, the consent is managed with the field 'User Consent Category'. You should enter a category ID, the one corresponding to Facebook (advertising) on Trust consent categories.

For customers without our product TRUST Commander:

We should distinguish 3 cases:

Your online events are collected through our Commanders Act event's tag: You have to provide, in the event tags, the list of category ids consented by the user, through the consent_categories property.
You are pushing your events to us through API or CSV file: a field consent_categories must be added on the JSON or CSV to precise the consent category IDs of the user. Then inside the connector setting, use the field 'User Consent Category' to enter a category ID, the one corresponding to Facebook (advertising)
You already manage consents on your side and you only send us, from your server,
events that obtained the consent for the category advertising. In this case, do not fill the field ‘User Consent Category’ in the connector.

How the deduplication between the pixel and server is managed?

Using both the pixel and server is recommended per Facebook as it could avoid losing data.

To make it works, you should have the same configuration for both the pixel and server, using same Facebook parameters.

event_id should be the same

On the pixel, event_id is automatically generated by our Commanders Act Tag and we retrieve the same value for the server on integrations.facebook.event_id. As a result, these 2 values should be the same. Event_name should be the same also.

Fbp parameter is automatically retrieved to keep the same value between pixel and server.

Deduplication works when the same event is sent first from the browser and then from the server, otherwise it creates a duplicate. Events are pushed in real-time.

Examples

On pixel:

fbq('track', 'AddToCart', {
  value: #CARTVALUE#,
  currency: #CURRENCY#,
  contents: fb_addtocart_products,
  content_type: 'product'
}, { eventID: tC.uniqueEventId });

eventID: tC.uniqueEventId is automatically generated.

On server:

integrations.facebook.event_id

integrations.facebook.event_id automatically retrieves the eventID value coming from the pixel (eventID: tC.uniqueEventId) for standard events.

Mappings to Facebook Standard Events

The Facebook CAPI Destination will turn the Commanders Act event like...

{
  "event_name": "purchase",
  "id": "purchase_id_1234",
  "type": "online",
  "user": {
    "email": "user@example.com",
    "id": "user_example_id",
    "tcId": "202205231352367212315156",
    "consistent_anonymous_id": "202205231352367212315156",
    "consent_categories": [ "1", "2", "3", "4" ]
  }
  "value": 246.9,
  "currency": "EUR",
  "items": [
    {
      "product": {
        "id": "product123"
      },
      "price": "123.45",
      "id": "ET",
      "item_category": "Car",
      "item_quantity": 2
    }
  ],
  "context": {
    "event_id": "1a01c3e940f150eb9b8c542587f1abfd8f0e1cc1f",
    "event_timestamp": 1707830130234,
    "page": {
      "location": {
        "href": "https://site.com/path?s=2",
        "hostname": "site.com",
        "pathname": "/path",
        "search": "?s=2"
      },
      "url": "https://site.com/path?s=2"
    },
    "device": {
      "ip": "123.123.123.123",
      "user_agent": "Mozilla/5.0 (Windows NT 10.0; Win64; x64) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/121.0.0.0 Safari/537.36"
    },
    "cookie": "_fbp=fb.1.1653472342558.832801021; some_other=cookie;"
  },
  "integrations": {
    "facebook": {
      "custom_data": {
        "category": "category1"
      },
      "user_data": {
        "fbp": "fb.1.1558571054389.1098115397"
      }
    }
  },
}

...into Facebook CAPI events like :

{
  "event_name": "Purchase",
  "event_time": 1707830130,
  "event_source_url": "https://site.com/path?s=2",
  "action_source": "website",
  "user_data": {
    "em": [
      "b4c9a289323b21a01c3e940f150eb9b8c542587f1abfd8f0e1cc1ffc5e475514"
    ],
    "external_id": [
      "user_example_id"
    ],
    "client_ip_address": "123.123.123.123",
    "client_user_agent": "Mozilla/5.0 (Windows NT 10.0; Win64; x64) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/121.0.0.0 Safari/537.36",
    "fbc": "fb.1.1554763741205.AbCdEfGhIjKlMnOpQrStUvWxYz1234567890",
    "fbp": "fb.1.1558571054389.1098115397"
  },
  "custom_data": {
    "id": "purchase_id_1234",
    "currency": "EUR",
    "value": 246.9,
    "contents": [
      {
        "id": "product123",
        "quantity": 2,
        "item_price": 123.45
      }
    ]
  }
}

The following mappings are fully automated and do not require any additional configuration by default. You can still customize each as follows.

Mapping: (root)

Most properties can be remapped using our "Smart Mapping" feature.

Commanders Act Properties

Facebook Properties

event_id [2][3]

event_id [1]

event_name

event_name [4]

context.event_timestamp

event_time [5]

context.page.url

event_source_url

context.page.referrer

referrer_url

Enable App tracking

type

action_source [6]

opt_out [3]

opt_out [7]

data_processing_options [3]

data_processing_options [7]

data_processing_options_country [3]

data_processing_options_country [7]

data_processing_options_state [3]

data_processing_options_state [7]

[1] Set based on available properties, in the reported order on the left. Default to a random generated value based on the timestamp. [2] In the base path/root of your event. [3] In integrations.facebook of your event. [4] See Mapping: event_name for more details. [5] If no value is provided the current timestamp is used. [6] See Mapping: action_source for more details. [7] See more details following this LINK.

Mapping: `event_name`

Facebook Pixel specifies Standard Events whose semantics correspond to events in the Commanders Act Standard

If the destination receives a Commanders Act Event with event_name matching the list, it will automatically be sent under the associated Facebook Standard Event name. Otherwise, it will be sent without any transformation

Commanders Act Events

Facebook Events

begin_checkout

InitiateCheckout

purchase

Purchase

add_to_cart

AddToCart

view_item

ViewContent

view_item_list

ViewContent

search

Search

add_payment_info

AddPaymentInfo

add_to_wishlist

AddToWishlist

generate_lead

Lead

page_view

PageView

sign_up

CompleteRegistration

contact

Contact

customize_product

CustomizeProduct

donate

Donate

find_location

FindLocation

schedule

Schedule

search

Search

start_trial

StartTrial

submit_application

SubmitApplication

subscribe

Subscribe

Examples:

If the destinations sees a add_to_cart event (IN the list), it will send an AddToCart to Facebook CAPI
If the destinations sees a custom_name event (NOT IN the list), it will send an custom_name to Facebook CAPI (no transformation)

Remark: You can customise the event_name using Properties Transformations in Destination settings.

Mapping: `action_source`

By default, action_source will be set to 'website' (most events relate to online activity). IF Enable App tracking is checked THEN action_source='app'

Offline conversions specificity:

IF your event has the property type='offline'
THEN the Facebook Event will have action_source='physical_store'
ELSE the Facebook Event will have action_source='website'

Example :

// CommandersAct
{
  "event_name": "purchase",
  "type": "offline",
  // ...
}

// Event sent to Facebook API:
{
  "event_name": "Purchase",
  "action_source": "physical_store"
  "custom_data": { /* */ }
  // ...
}

If you need to overwrite this value, you currently can use Properties Transformation to set the integrations.facebook.action_source.

Mapping: `user_data`

Most properties can be remapped using our "Smart Mapping" feature.

Commanders Act Properties

Facebook Properties

user.id (hashed) context.device.sdk_id user.tcId , user.tcid or user.tc_id

user_data.external_id [1]

user.email

user_data.em (email, hashed)

user.phone

user_data.ph (phone, hashed)

user.gender

user_data.ge (gender, hashed)

user.birthdate

user_data.db (birthdate, hashed)

user.lastname

user_data.ln (last name, hashed)

user.firstname

user_data.fn (first name, hashed)

user.city

user_data.ct (city, hashed)

user.state

user_data.st (state, hashed)

user.zipcode

user_data.zp (zip code, hashed)

user.country

user_data.country (hashed)

ip [3][4]

user_data.client_ip_address

user_agent [3][4]

user_data.client_user_agent

fbc [2] The cookie "_fbc" [5]

user_data.fbc (Click ID)

fbp [2] The cookie "_fbp" [5]

user_data.fbp (Browser ID)

advertising_id [3]

user_data.anon_id [6] user_data.madid [6]

user_data[Property Name] [7]

user_data[Property Name]

[1] Comma-separated string: values in the order provided on the left. [2] In integrations.facebook or in the root of your events with the first having priority. [3] In context.device of your event. [4] Automatically set if generated by Commanders Act OneTag. [5] Automatically created by the Facebook Pixel client-side tag. [6] Only for app events. [7] In integrations.facebook of your event.

Every property can be overridden using integrations.facebook.user_data.<property>

Minimal required information

Events can only be used if there is enough information to match a user. Facebook expects at least one user_data property, but strongly advises sending as many properties as possible.

Here are our conditions to send the events :

at least 1 of those fields: em, ph, external_id, fbp, fbc
at least 3 of the other fields

Note : external_id, fbp, fbc will allow matching event with other events. But to match a user, one of those events shall contain additional information (em and ph are best suited for matching)

Mapping: `custom_data`

Most properties can be remapped using our "Smart Mapping" feature.

Commanders Act Properties

Facebook Properties

value

custom_data.value

currency

items.0.currency

custom_data.currency

id

custom_data.order_id

search_term

custom_data.search_string

items.X.id

custom_data.contents.X.id

items.X.quantity

custom_data.contents.X.quantity

items.X.product.price

custom_data.contents.X.item_price

items.0.product.name

custom_data.content_name

items.0.product.category_1

custom_data.content_category

items.X.id

custom_data.content_ids [1]

Content type value

custom_data.content_type [2]

status

custom_data.status

items.length

custom_data.num_items

Send all your event properties as custom data

custom_data[Property Name] [3]

custom_data[Propery Name] [4]

custom_data[Property Name]

[1] Array containing all product identifiers. [2] Depending on the selected value for Content type value , which can be found under Advanced Settings , this is either product or not set. [3] When Send all your event properties as custom data is checked all properties in your event with type "string", "number" and "boolean" will be included in custom_data with the same property name. [4] In integrations.facebook in your event.

Default behavior

Facebook specifies rules for standard properties. The rest is completely free.

By default, we fill custom_data as follows :

We copy all CommandersAct Event properties into custom_data (except some context fields like source_key)
Then we map the standard properties according to the table above (can overwrite 1. values)
Finally, we overwrite with integrations.facebook.custom_data.<property> if exists

Overwrite `custom_data`

Best choice would be to use Properties Transformation to modify your event properties which will be copied into custom_data.

But you can override the final value using integrations.facebook.custom_data.<property>.

Example :

cact('trigger', 'purchase', {
    "currency": "EUR",
    "value": 101,
    "integrations": {
        "facebook": {
            "custom_data": {
                "content_name": "some_custom_name",
                "your_field": "your_value"
            }
        }
    }
});

Mapping: `app_data`

Most properties can be remapped using our "Smart Mapping" feature.

Commanders Act Properties

Facebook Properties

ad_tracking_enabled [1]

advertiser_tracking_enabled

application_tracking_enabled [1]

application_tracking_enabled

context.campaign.name

campaign_ids

install_referrer [2]

install_referrer

installer_package [2]

installer_package

url_schemes [2]

url_schemes

windows_attribution_id [2]

windows_attribution_id

type [1]

extinfo[0] [3]

app.namespace [1]

extinfo[1]

app.build [1]

extinfo[2]

app.version [1]

extinfo[3]

os.version [1]

extinfo[4]

model [1]

extinfo[5]

language [1]

extinfo[6]

[No default field] [4]

extinfo[7]

network.carrier [1]

extinfo[8]

screen.width [1]

extinfo[9]

screen.height [1]

extinfo[10]

screen.density [1]

extinfo[11]

[No default field] [5]

extinfo[12]

[No default field] [6]

extinfo[13]

[No default field] [7]

extinfo[14]

timezone [1]

extinfo[15]

[1] In context.device of your event. [2] In integrations.facebook or in the root of your events with the first having priority. [3] When context.device.type is set with Android or iOS (case insensitive), this is set with a2 or i2 respectively. [4] Can be set in Smart Mapping → App Data → Device Abbreviated Timezone . [5] Can be set in Smart Mapping → App Data → CPU Cores . [6] Can be set in Smart Mapping → App Data → External Storage Size . [7] Can be set in Smart Mapping → App Data → Available Storage Size .

`integrations.facebook.*` deprecation

integrations.facebook.* usage will be deprecated. The feature is still working, but it is recommended to use the destination settings instead for maintenance and reliability purpose.

Check results on Facebook interface

To view quality matching on Facebook interface, go here: Events manager > select the event > View Details > Event Matching > Rating Background

How to send offline conversions

The recommanded way is to use the HTTP Tracking API source to send your offline events from your servers (or any other emmiter). You just need to send a purchase event with the type property equals to offlineMore details on the automatic mapping here: Mapping action_source

Google Universal Analytics

Google is a multinational technology company focusing on online advertising, search engine technology, cloud computing, and computer software. Google Universal Analytics (UA) is a web analytics service that tracks and reports website traffic. Using this destination, you can take advantage of the Measurement Protocol by sending data via server-side. This version is related to the previous generation of Google Analytics. See Google Analytics 4 destination for the newest and recommended version.

Google Universal Analytics will be deprecated on July 1, 2023, meaning it will stop processing data. Analytics 360 properties will stop working on October 1, 2023.

Key features

The Google Universal Analytics destination provides the following key features:

Events structure: our Events reference model covers Google's hit types, 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.
Smart mapping: data mapping can be readjusted using your datalayer defined fields.
Refined data: you can freely push additional information based on your specific needs (E.g. adding custom events and custom properties).
Support for multi-item data: information included in the item array is dispatched to UA.

Destination setup

Configuration

Settings

Description

Tracking ID

Required

The tracking identifier is a string like "UA-XXXXXX-Y". It must be included in your tracking code to tell Analytics which account and property to send data to.

Custom Event Properties

Client Id Cookie Name

Cookie name holding the Google Analytics "Client Id" that uniquely identifies a user instance of a web client. Default value: "_ga".

The "Client Id" is the right most string in the cookie, including a single dot. E.g. see the following blue highlighted string "GA1.1.XXXXXXXXXX.XXXXXXXXXX".

[1] Using "dots" (".") you can navigate deeper to the specific field you want to get the value of. See Events reference for more details on the standard field names by event. You can also freely set custom fields: there are no boundaries.

Quick reference

As recommended by Google, Enhanced Ecommerce hits are used in place of Ecommerce hits. See more details on UA "Hit Types" following this LINK.

Commanders Act Events

UA Hit Types

add_payment_info

add_shipping_info

begin_checkout

page_view

purchase

pageview [1]

screenview [1]

add_to_cart

add_to_wishlist

generate_lead

login

refund

remove_from_cart

search

select_content

select_item

sign_up

view_cart

view_item

view_item_list

[Custom Event]

event

[Custom Event]

social [2]

[1] This is either pageview or screenview , depending if the "Smart Mapping" field App Name (an) is set with an empty value or a non-empty one. [2] You can specify a custom social event by setting the "Smart Mapping" field Social Event .

Field mappings

Most properties can be remapped using our "Smart Mapping" feature.

Commanders Act Properties

Google Properties

Tracking ID

tid

partners.ga.client_id

Client Id Cookie Name

user.tcId

cid [1]

user.id

uid

context.device.ip

uip [2]

partners.ga.ad_id

gclid

context.page.url

dl

context.page.title

dt

context.page.referrer

dr

context.page.url

dh [3]

context.page.url

dp [3]

id

ti

value

tr

shipping_amount

ts

tax_amount

tt

coupon

tcc

partners.ga.affiliation

ta

currency

cu

partners.ga.product_action [Default Value]

pa [4]

partners.ga.event_category

ec [5]

partners.ga.event_action

event_name

ea [6]

partners.ga.event_label

search_term

item_id

method

el [7]

items.X.id

pr(X+1)id

items.X.product.name

pr(X+1)nm

items.X.product.category_1 / items.X.product.category_2 / items.X.product.category_3 / items.X.product.category_4 / items.X.product.category_5

pr(X+1)ca

items.X.product.brand

pr(X+1)br

items.X.variant

pr(X+1)va

items.X.list_position

pr(X+1)ps

items.X.product.price

pr(X+1)pr

items.X.quantity

pr(X+1)qt

items.X.coupon

pr(X+1)cc

items_impression.X.0.list_name

il(X+1)nm

items_impression.X.Y.id

il(X+1)pi(Y+1)id

items_impression.X.Y.name

il(X+1)pi(Y+1)nm

items_impression.X.Y.brand

il(X+1)pi(Y+1)br

items_impression.X.Y.category_1

il(X+1)pi(Y+1)ca

items_impression.X.Y.variant

il(X+1)pi(Y+1)va

items_impression.X.Y.list_position

il(X+1)pi(Y+1)ps

items_impression.X.Y.price

il(X+1)pi(Y+1)pr

items_promotion.X.id

promo(X+1)id

items_promotion.X.name

promo(X+1)nm

items_promotion.X.creative

promo(X+1)cr

items_promotion.X.position

promo(X+1)ps

items_promotion.X.action

promoa

partners.ga.campaign_name

cn

partners.ga.campaign_source

cs

partners.ga.campaign_medium

cm

partners.ga.campaign_keyword

ck

partners.ga.campaign_content

cc

partners.ga.campaign_id

ci

partners.ga.queue_time

qt

context.app.name

an

context.app.namespace

aid

context.app.namespace

aiid

context.app.version

av

context.page.title

cd

(partners.ga.event_npa)

npa [8]

(partners.ga.non_iteration)

ni [9]

partners.ga.checkout_step

cos

partners.ga.checkout_step_option

col

partners.ga.social_name

sn

partners.ga.social_action

sa

partners.ga.social_action_target

st

Custom Event Properties

[Custom Property Name] [10]

[1] partners.ga.client_id has priority over Client Id Cookie Name and user.tcId . [2] Always anonymized just as though aip (anonymize IP) is used. [3] Retrieved by parsing the provided "Smart Mapping" field Document Location (dl) . [4] If items is not set, then this property won't be present. If partners.ga.product_action is not set, depending on the incoming event, the following values are used as default: detail (page_view event or if your event is not one of the following being listed), purchase (purchase event), click (search, add_to_wishlist, login, select_content, select_item, sign_up, view_cart, view_item and view_item_list events), refund (refund event), checkout (begin_checkout, add_shipping_info and add_payment_info events), add (add_to_cart event), remove (remove_from_cart event). [5] If partners.ga.event_category is not set, since this property is required for "event" hit types, this gets the default value: UX . [6] If partners.ga.event_action is not set, then your event name is used. [7] If partners.ga.event_label is not set, depending on the incoming event, the following fields are used as default: search_term (search event), item_id (select_content event) and method (sign_up and login events). [8] If partners.ga.event_npa is set with one of the following values: 1 (string or integer) or true (boolean), then npa is set with 1 . [9] If partners.ga.non_iteration is set with one of the following values: 1 (string or integer) or true (boolean), then npa is set with 1 . [10] See Custom Event Properties in Configuration for more details on how you can bridge custom properties to UA.

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 Events reference matches Piano Analytics' one, 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.
Support for multi-item data: information included in the item array is dispatched to Piano Analytics.
User identifier: you can openly select a user identifier field for logged users.
Support autopromo events: include pre-prepared autopromo events in your requests. See Autopromo events for more details.
Send all properties: send all your event properties to Piano Analytics with a single click.

Destination setup

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

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

Configuration

Settings

Description

Side Id

Secured Collection Domain

User Identifier

Custom Property

When selecting "[Custom Property]" as value for the above User Identifier, this field will show up so you can specify a custom field holding the value for the user identifier [2].

Client Identifier

Custom Property

When selecting "[Custom Property]" as value for the above Client Identifier, this field will show up so you can specify a custom field holding the value for the client identifier [2].

Custom Event Mapping: "view_item" matched with Piano "product.page_display"

Send Autopromo Events

Send All Properties

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].

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 .

[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 Events reference for more details on the standard field names by event. You can also freely set custom fields: there are no boundaries.

Quick reference

Piano Analytics video/audio events are supported by our event model.

Commanders Act Events

Piano Analytics Events

add_payment_info

cart.payment

add_shipping_info

cart.delivery

add_to_cart

product.add_to_cart

add_to_wishlist

product.add_to_wishlist [*]

begin_checkout

cart.begin_checkout [*]

generate_lead

generate_lead [*]

login

user.login [*]

page_view

page.display or product.page_display [1]

purchase

transaction.confirmation and product.purchased [2]

refund

refund [*]

remove_from_cart

product.remove_from_cart

search

internal_search_result.display

select_content

select_content [*]

select_item

page.select_item [*]

sign_up

user.sign_up [*]

video_ad_complete

video_ad_stop

video_complete

video_content_complete

av.stop

video_ad_click

av.ad.click

video_ad_playing

video_content_playing

video_ad_break_complete

video_content_quarter_reached

av.heartbeat

video_content_start

video_ad_start

video_ad_break_start

av.start

video_ad_skip

av.ad.skip

video_buffer_start

av.buffer.start

video_buffer_complete

av.buffer.heartbeat

video_error

av.error

video_fullscreen_off

av.fullscreen.off

video_fullscreen_on

av.fullscreen.on

video_pause

av.pause

video_quality

av.quality

video_resume

av.resume

video_seek_start

av.seek.start

video_share

av.share

video_speed

av.speed

video_start

av.play

video_subtitle_off

av.subtitle.off

video_subtitle_on

av.subtitle.on

video_volume

av.volume

view_cart

cart.display

view_item

product.display [3]

product.page_display [3]

view_item_list

page.view_item_list [*]

[Any Other Event]

[Custom Event] [*]

Field mappings

Commanders Act Properties

Piano Analytics Properties

(event_timestamp)

device_timestamp_utc [1]

context.page.referrer

previous_url

page_name

page

value

generate_lead_value

cart_turnovertaxincluded

currency

generate_lead_currency

cart_currency

id

transaction_id

generate_lead_id

item_list_name

view_item_list_name

method

login_method

sign_up_method

content_type

item_id

search_term

ise_keyword

items.X.id

product_id [2]

items.X.product.name

product [2]

items.X.variant

product_variant [2]

items.X.product.brand

product_brand [2]

(items.X.discount > 0)

product_discount [2][3]

items.X.product.price

product_pricetaxincluded [2]

items.X.product.currency

product_currency [2]

items.X.product.category_1

product_category1 [2]

items.X.product.category_2

product_category2 [2]

items.X.product.category_3

product_category3 [2]

items.X.product.category_4

product_category4 [2]

items.X.quantity

product_quantity [2]

cart_quantity [4]

items.X.coupon

product_promocode [2]

coupon

transaction_promocode

payment_method

payment_mode

shipping_amount

shipping_costtaxincluded

shipping_tier

shipping_delivery

cart_id

revenue

cart_turnovertaxfree

items.length

cart_nbdistinctproduct

user.id

user.email

user.email_md5

user.email_sha256

[custom_property]

user_id [5]

context.device.manufacturer

device_manufacturer

context.device.model

device_model

context.device.screen.height

device_screen_height

context.device.screen.width

device_screen_width

content_asset_id

av_content_id [6]

(page.url) or (page.location.href)

src_medium [7]

(page.url) or (page.location.href)

src_campaign [8]

(page.url) or (page.location.href)

src_variant [9]

(page.url) or (page.location.href)

src_format [10]

video_session_id

av_session_id

cursor_position * 1000

av_position

prev_cursor_position * 1000

av_previous_position

time_prev_event

av_duration

prev_event_name

av_previous_event

video_title

av_content

video_category

av_content_type

total_length * 1000

av_content_duration

content_linked

av_content_linked

airdate

av_publication_date

keywords

av_content_genre

program

av_show

season

av_show_season

episode

av_episode_id

episode_label

av_episode

channel

av_channel

publisher

av_author

content_version

av_content_version

content_duration_range

av_content_duration_range

(livestream)

av_broadcasting_type [11]

broadcaster_name

av_broadcaster

ad_type

av_ad_type

video_player

av_player

video_player_version

av_player_version

auto_play

av_auto_mode

video_language

av_language

video_subtitles_language

av_subtitles

video_launch_reason

av_launch_reason

interruption_method

av_player_error

seek_position

av_seek_position

bitrate

av_bitrate

framerate

av_framerate

sound

av_sound

full_screen

av_fullscreen

ad_enabled

av_ad_enabled

image_quality

av_image_quality

content_pod_id

ad_pod_id

av_pod_id [6]

video_description

av_description

full_episode

av_full_episode

[1] In seconds. [2] Field included for the following events: add_to_cart , page_view (product.page_display) , view_item , purchase (product.purchased) , remove_from_cart , add_to_wishlist , and select_item . [3] Boolean value: true or false . [4] Sum all items.X.quantity . [5] Depending on the drop-down selection (See User Identifier in theConfigurationsection), a specific Commanders Act property is used. [6] Field converted to string. [7] Parsed from the utm_medium parameter in the provided url. [8] Parsed from the utm_campaign parameter in the provided url. [9] Parsed from the utm_content parameter in the provided url. [10] Parsed from the utm_creative_format parameter in the provided url. [11] This is either "Live" or "Recorded Broadcast".

Headers parameters

Commanders Act Properties

Piano Analytics Fields

device.user_agent

User-Agent

page.url

page.location.href

Referer

device.ip

X-Forwarded-For

Autopromo events

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

...
"autopromos": [
        {
          "name": "self_promotion.display",
          "data": {
            "onsitead_type": "Self promotion",
            "onsitead_campaign": "trv_tem",
            "onsitead_category": "opt_tem",
            "onsitead_creation": "https://mysite.com/hp-autopromo.png",
            "onsitead_detailed_placement": "hp_autopromo"
          }
        },
        {
          "name": "self_promotion.display",
          "data": {
            "onsitead_type": "Self promotion",
            "onsitead_campaign": "trv_tem2",
            "onsitead_category": "opt_tem2",
            "onsitead_creation": "https://mysite.com/hp-autopromo-2.png",
            "onsitead_detailed_placement": "hp_autopromo_2"
          }
        }
],
...

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 Configuration for more details.

Piwik PRO

Piwik PRO "Analytics Suite" is a privacy-focused platform for tracking and analyzing user behavior on websites and other digital products. Their product is an alternative to Google Analytics, geared towards compliance with strict security policies and privacy regulations. Using this destination, you can leverage Piwik PRO Tracking HTTP API to send events. The data sent to this API will be processed and eventually appear in Analytics reports.

Key features

The Piwik PRO destination provides the following key features:

Events structure: our Events reference model matches Piwik PRO's event types (See query parameter e_t ), 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.
Smart mapping: data mapping can be readjusted using your datalayer defined fields.
Event mapping: change standard mapping between your partners' events and yours or add new mappings.
Support for multi-item data: information included in the item array is dispatched to Piwik PRO.

Destination setup

Configuration

Settings

Description

Instance Name

Required

Your instance name as provided by Piwik PRO (E.g. for https://InstanceName.piwik.pro/ppms.php, include the bold string only).

Application Id

RequiredYour application identifier (Previously "Website Id") as provided by Piwik PRO.

Goal Identifiers

Map your goal identifiers by setting the ids in Piwik PRO goal identifiers and adding event names in Your event name. Goal Id "0" is reserved for E-commerce cart tracking.

Custom Dimensions

Map your custom dimensions by setting their field names in Piwik PRO dimension name and adding its value in Your value. E.g. if you inputsizein the Piwik PRO dimension name and items.0.product.size in Your value, you'll have a custom dimension in Piwik PRO calledsizewith a value based on the content of the field items.0.product.size [1].

Custom Session Variables

Custom Event Variables

Event Mapping

Change the standard mapping between Piwik PRO's events and yours or add new mappings.

Quick reference

Commanders Act Events

Piwik PRO Event Types

add_to_cart

add-to-cart

purchase

order

remove_from_cart

remove-from-cart

update_cart

cart-update

[Any Event]

[Any Event] [1]

[1] See Event Mapping for more details.

Field mappings

Most properties can be remapped using our "Smart Mapping" feature. It's recommended to include the visitor identifier in your requets - See Piwik Pro property _id for more details.

Commanders Act Properties

Piwik Pro Properties

Application Id

idsite [*]

context.page.url

url

link

event_name

action_name

user.id

uid [1]

partners.piwik_pro.visitor_id

_id [2]

partners.piwik_pro.config_id

cid [3]

partners.piwik_pro.anon_tracking

uia [4]

context.page.referrer

urlref

Custom Session Variables

_cvar [5]

Custom Event Variables

cvar [6]

context.device.ip

cip

context.device.screen.widthx context.device.screen.height

res [7]

(context.event_timestamp)

h, m, s [8]

context.device.user_agent

ua

context.device.lang

lang

user.country

country

user.city

city

Custom Dimensions

[Custom Dimension] [9]

search_term

search

Goal Identifiers

idgoal [10]

revenue

ec_st

e_t

id

ec_id

[[items.X.id,items.X.product.name,[items.X.product.category_1, ..., items.X.product.category_5], items.X.product.price,items.X.quantity,items.X.product.brand,items.X.variant, { [Custom Product Dimension Id Y]: [Custom Product Dimension Value Y], ..., [Custom Product Dimension Id Y+N]: [Custom Product Dimension Value Y+N]}]]

ec_products [11]

tax_amount

ec_tx

shipping_amount

ec_sh

(items.X.discount)

ec_dt [12]

partners.piwik_pro.page_view_id

pv_id [13]

partners.piwik_pro.force_new_visit

new_visit [14]

partners.piwik_pro.visit_counter

_idvc [15]

partners.piwik_pro.prev_visit

_viewts [16]

partners.piwik_pro.first_visit

_idts [17]

partners.piwik_pro.download_url

download [18]

partners.piwik_pro.search_categories

search_cats

partners.piwik_pro.search_count

search_count

partners.piwik_pro.last_order_timestamp

_ects [19]

partners.piwik_pro.custom_event_category

e_c [20]

partners.piwik_pro.custom_event_action

e_a [21]

partners.piwik_pro.custom_event_value

e_v [22]

partners.piwik_pro.content_name

c_n [23]

partners.piwik_pro.content_piece

c_p [24]

partners.piwik_pro.content_target

c_t [25]

partners.piwik_pro.content_interaction

c_i [26]

[*] Mandatory property. [1] Can be used to identify visitor by the application (e.g. login name, email address or internal user ID). More details are available following: Recognizing Visitors. [2] This allows you to use the application identifier of a visitor instead of a default identifier generated by Piwik PRO analytics. More details are available following: Recognizing Visitors. If you don't pass a value, this destination tries to recover it from the cookie named _pk_id.[Application Id]. More details are available following this LINK. [3] Semi-unique hash generated for the visitor's browser (based on configuration and installed plugins). This parameter overwrites visitor identifier sent with _id property. [4] Whether the user should be tracked anonymously: 1 all IP bytes will be masked (0.0.0.0), GeoIP data below country level will be anonymized, 0 available visitor data will be added to the session. [5] See Custom Session Variables for more details. [6] See Custom Event Variables for more details. [7] Screen resolution (E.g. 1920x1080). [8] Hour, minute and second when the request was made. [9] See Custom Dimensions for more details. [10] See Goal Identifiers for more details. [11] [Custom Product Dimension Id Y] must be a numeric identifier starting from 1 and must be incremented for every new custom product dimension being set in Custom Dimensions. [12] Sum of all product discounts. [13] Unique page view identifier generated when the page is loaded. [14] Force start of new visit when value is 1 . Allowed values: 0 or 1 . [15] Visit counter. [16] Time of previous visit in UNIX timestamp format: number of seconds. [17] Time of first visit. [18] URL of downloaded file. [19] Time of the last ecommerce order in UNIX timestamp format: number of seconds. [20] Custom event category. More details are available following this LINK. [21] Custom event action. More details are available following this LINK. [22] Content event value. More details are available following this LINK. [23] Content name. More details are available following this LINK. [24] Content piece. More details are available following this LINK. [25] Content target. More details are available following this LINK. [26] Content interaction. More details are available following this LINK.