# Adobe Analytics (Early Access)

[Adobe Analytics](https://business.adobe.com/products/analytics/adobe-analytics.html)  is a powerful analytics reporting and visualization tool that helps users slice their data and gain insights quickly.

{% hint style="danger" %}
The Adobe Analytics destination is currently an experimental destination. Please contact <support@freshpaint.io> for more information about this integration.
{% endhint %}

## Destination Info

* Connection Modes:

<table><thead><tr><th align="right"> </th><th data-type="checkbox">Client-side</th><th data-type="checkbox">Server-side</th></tr></thead><tbody><tr><td align="right">Web</td><td>false</td><td>true</td></tr><tr><td align="right">Mobile</td><td>false</td><td>true</td></tr><tr><td align="right">Server</td><td>false</td><td>true</td></tr></tbody></table>

## What You'll Need

* Freshpaint account
* An account with Adobe Analytics

## Getting Started

1. Navigate to the Adobe Analytics destination configuration

<figure><img src="https://1666823438-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2F-MA7aDqsXMFbUsWVqonF%2Fuploads%2FB8lwVnvnHgafLKtyNakG%2Fimage.png?alt=media&#x26;token=2914cae1-7c91-4836-b372-9fbc122f493f" alt=""><figcaption></figcaption></figure>

2. Configure your Report Suite ID ID. This can be found in your Adobe Analytics Report Suite Admin settings page:

<figure><img src="https://1666823438-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2F-MA7aDqsXMFbUsWVqonF%2Fuploads%2Fhx256UrBx0xksGApUPNy%2Fimage.png?alt=media&#x26;token=d5fc2bd5-f15d-4168-8879-105294bce6bd" alt=""><figcaption><p>There are 3 Report Suite IDs displayed and the Report Suite ID <code>example-report-three</code> is currently selected.</p></figcaption></figure>

<figure><img src="https://1666823438-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2F-MA7aDqsXMFbUsWVqonF%2Fuploads%2FHQp1BD0VPv530gOeT28f%2Fimage.png?alt=media&#x26;token=c523d0a6-c15f-4ead-bf4e-efec7ae1c0f6" alt="" width="375"><figcaption></figcaption></figure>

3\. That's it! You should now see the [enabled status](https://documentation.freshpaint.io/readme/setting-up-your-destinations/enabling-and-disabling-a-destination) next to Adobe Analytics.

## Server-side

Freshpaint's servers use the same API as the client-side adobe analytics tag. You may provide the following additional event properties:

<table><thead><tr><th>Freshpaint Property</th><th width="108.33333333333331" data-type="checkbox">Required?</th><th>Description</th></tr></thead><tbody><tr><td><code>pe</code></td><td>false</td><td><strong>Note:</strong>  <code>pe</code> <strong>is a required property for Link click events, and it cannot be included in Page events.</strong><br><code>pe</code> is the type of the event, and it can take of of the following values:   ("custom", "download", "exit")</td></tr><tr><td><code>pev2</code></td><td>false</td><td><strong>Note:</strong>  <code>pev2</code> <strong>is a required property for Link click events, and it cannot be included in Page events.</strong><br>The name of the event</td></tr><tr><td><code>imsRegion</code></td><td>false</td><td><strong>Note</strong>: If you specify this you must also define a <code>Marketing Cloud Visitor Id</code></td></tr><tr><td><code>currency</code></td><td>false</td><td>The currency code of the purchase.</td></tr><tr><td><code>characterSet</code></td><td>false</td><td><p>The <code>charSet</code> variable is used by Adobe to convert incoming data into UTF-8 for storage and reporting by Analytics. Most sites do not need to set this variable.</p><p>Set this variable only if you see garbled values (<a href="https://en.wikipedia.org/wiki/Mojibake">mojibake</a>) in reports. You can set this variable on a page-by-page basis if your site uses different encodings on different pages.</p></td></tr><tr><td><code>channel</code></td><td>false</td><td>The <code>channel</code> variable typically stores the section of the site a given page is on. It is helpful to determine what groups of your site are most popular. This variable populates the ‘Site Sections’ dimension.</td></tr><tr><td><code>event1</code> to <code>event1000</code></td><td>false</td><td>Dimensions and metrics are vital components to reports. The <code>events</code> variable is responsible for data collection of many metrics on your site. Events typically increment <a href="https://experienceleague.adobe.com/docs/analytics/components/metrics/overview.html?lang=en">metrics</a> in reports.</td></tr><tr><td><code>events</code></td><td>false</td><td>Comma separated list of events. These will be merged with individual event properties before sending to adobe.</td></tr><tr><td><code>$current_url</code></td><td>false</td><td>The URL of the page</td></tr><tr><td><code>homepage</code></td><td>false</td><td><code>Y</code> or <code>N</code> Whether the current page is the visitor's homepage</td></tr><tr><td><code>javascriptVersion</code></td><td>false</td><td>JavaScript version. For example, 1.3.</td></tr><tr><td><code>mcorgid</code></td><td>false</td><td>The Experience Cloud Organization ID; it identifies the organization within the Adobe Experience Cloud.</td></tr><tr><td><code>marketingCloudVisitorID</code></td><td>false</td><td>Experience Cloud ID. See <a href="https://github.com/AdobeDocs/analytics-1.4-apis/blob/master/docs/data-insertion-api/overview/c_visitor_id.md">Visitor Identification</a> and the <a href="http://microsite.omniture.com/t2/help/en_US/mcvid/">Experience Cloud Visitor ID Service</a>.</td></tr><tr><td><code>plugins</code></td><td>false</td><td>Semicolon separated list of Netscape plug-in names.</td></tr><tr><td><code>pageName</code></td><td>false</td><td><p>The <code>pageName</code> variable typically stores the name of a given page. It is helpful to determine what individual pages are most popular. This variable populates the <a href="https://experienceleague.adobe.com/docs/analytics/components/dimensions/page.html?lang=en">Page</a> dimension.</p><p>If this variable is not defined on a given page tracking call, the <a href="https://experienceleague.adobe.com/docs/analytics/implementation/vars/page-vars/pageurl.html?lang=en"><code>pageURL</code></a> variable is used instead.</p></td></tr><tr><td><code>pageType</code></td><td>false</td><td>The <code>pageType</code> variable is a flag used to designate error pages on your site, such as 404 errors. If this variable contains the string <code>errorPage</code>, it populates the ‘Pages Not Found’ <a href="https://experienceleague.adobe.com/docs/analytics/components/dimensions/pages-not-found.html?lang=en">dimension</a> and <a href="https://experienceleague.adobe.com/docs/analytics/components/metrics/pages-not-found.html?lang=en">metric</a>.</td></tr><tr><td><code>products</code></td><td>false</td><td>The <code>products</code> variable tracks products and properties tied to them. This variable is typically set on individual product pages, shopping cart pages, and purchase confirmation pages. It is a multi-value variable, meaning you can send multiple products in the same hit and Adobe parses the value into separate dimension items.<br><br>See <a href="https://experienceleague.adobe.com/docs/analytics/implementation/home.html?lang=en">Adobe Docs</a> on how to configure this field.</td></tr><tr><td><code>purchaseID</code></td><td>false</td><td>The <code>purchaseID</code> variable helps prevent hits containing the same purchase from inflating reports. For example, if a visitor reaches your purchase confirmation page, you typically send data around the revenue generated from the transaction to Adobe. If the user refreshes this page multiple times or bookmarks the page to visit later, those hits can inflate reports. The <code>purchaseID</code> variable de-duplicates metrics when more than one hit has the same purchase ID.</td></tr><tr><td><code>fallbackVisitorID</code></td><td>false</td><td>A fallback cookie <code>s_fid</code> is set when the primary cookie (<code>AMCV_</code> or <code>s_vi</code>) is unavailable. It has a 2 year expiration and is used as the fallback identification method going forward.</td></tr><tr><td><code>$screen_height</code></td><td>false</td><td>The screen height from the browser</td></tr><tr><td><code>$screen_width</code></td><td>false</td><td>The screen width from the browser</td></tr><tr><td><code>time</code></td><td>false</td><td>The timestamp of the event in unix epoch format.</td></tr><tr><td><code>javaEnabled</code></td><td>false</td><td>The ‘Java enabled’ <a href="https://experienceleague.adobe.com/docs/analytics/components/dimensions/overview.html?lang=en">dimension</a> determines if the browser at the time has Java enabled. </td></tr><tr><td><code>campaign</code></td><td>false</td><td>The <code>campaign</code> variable is dedicated to collecting tracking codes on your site.</td></tr><tr><td><code>$device_id</code> or <code>$user_id</code></td><td>false</td><td>The freshpaint unique identity for the device or the user. We pass this as the visitor ID to adobe.</td></tr><tr><td><code>transactionID</code></td><td>false</td><td>The <code>transactionID</code> variable uniquely identifies a transaction so the hit can tie to data uploaded through Data Sources. This variable is valuable in cases where you want to use data from other channels and link it to data collected with AppMeasurement.</td></tr><tr><td><code>colorDepth</code></td><td>false</td><td>The ‘Color depth’ <a href="https://experienceleague.adobe.com/docs/analytics/components/dimensions/overview.html?lang=en">dimension</a> reports how many colors that the device supports.</td></tr><tr><td><code>adobeProp1</code> to <code>adobeProp75</code></td><td>false</td><td>Props are custom variables that you can use however you’d like. They do not persist beyond the hit that they are set.</td></tr><tr><td><code>eVar1</code> to <code>eVar250</code></td><td>false</td><td>eVars are custom variables that you can use however you’d like. If you have a <a href="https://experienceleague.adobe.com/docs/analytics/implementation/prepare/solution-design.html?lang=en">solution design document</a>, most dimensions specific to your organization end up as eVars. By default, eVars persist beyond the hit they are set on. You can customize their expiration and allocation under <a href="https://experienceleague.adobe.com/docs/analytics/admin/admin-tools/manage-report-suites/edit-report-suite/conversion-variables/conversion-var-admin.html?lang=en">Conversion variables</a> in Report suite settings.</td></tr><tr><td><code>adobeList1</code> to <code>adobeList3</code></td><td>false</td><td>List variables are custom variables that you can use however you’d like. They work similarly to eVars, except they can contain multiple values in the same hit. List variables do not have a character limit.</td></tr><tr><td><code>adobeHier1</code> to <code>adobeHier5</code></td><td>false</td><td>Hierarchy variables are custom variables that let you see a site’s structure. Adobe supports up to 5 hierarchy variables in your implementation.</td></tr></tbody></table>
