# Viant Reference

This is a reference document for the Viant destination. For information on how to set up this integration, see the [viant-quick-start-guide](https://documentation.freshpaint.io/integrations/destinations/demand-side-platforms-dsps/viant/viant-quick-start-guide "mention").

## Destination Info

* Supports [Track](https://documentation.freshpaint.io/reference/developer/freshpaint-sdk-reference#track) calls
* Supports [HIPAA mode](https://documentation.freshpaint.io/readme/hipaa-mode)
* Supports [Freshpaint Impression Pixel](https://documentation.freshpaint.io/integrations/impression-pixel)
* Supports forwarding from the [Google Tag Manager Integration](https://documentation.freshpaint.io/integrations/google-tag-manager-integration)
* Refer to this destination as **viant** in the [Integrations object](https://documentation.freshpaint.io/reference/developer/freshpaint-sdk-reference#using-the-integrations-object)
  * If you've configured multiple Advertiser IDs, you can choose a specific one by suffixing the Advertiser ID, such as: **viant::123456.** You can retrieve this value from Viant configuration page for the Advertiser ID of interest.

{% hint style="info" %}
When no suffix is specified, all configured Advertiser IDs are selected for inclusion / exclusion.
{% endhint %}

* Connection Modes:

<table><thead><tr><th width="200.33333333333331" 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>

## Click Through Tracking

Freshpaint supports click through tracking by capturing the `viant_clid` query parameter on the landing page configured on your creative. You need to have the Freshpaint javascript snippet installed on the landing page for this to work. Assuming you have followed the [viant-quick-start-guide](https://documentation.freshpaint.io/integrations/destinations/demand-side-platforms-dsps/viant/viant-quick-start-guide "mention") to set up your Viant destination, you can verify that click through tracking is working by looking for an event in event verification that contains the `$viant_clid` field.

<div data-full-width="true"><figure><img src="https://1666823438-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2F-MA7aDqsXMFbUsWVqonF%2Fuploads%2FRUkhaTUi4mQeUZp27OIq%2FScreenshot%202024-11-15%20at%202.28.04%E2%80%AFPM.png?alt=media&#x26;token=f6436c39-398d-4ac2-81ec-594895fa91a1" alt=""><figcaption><p>Event verification</p></figcaption></figure></div>

<figure><img src="https://1666823438-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2F-MA7aDqsXMFbUsWVqonF%2Fuploads%2FrvFQsWapihKxo6ikLWDR%2FScreenshot%202024-11-15%20at%202.35.58%E2%80%AFPM.png?alt=media&#x26;token=6911f620-c52f-49b0-9dae-3ecd2cabc79d" alt=""><figcaption><p>Click ID being captured</p></figcaption></figure>

## View Through Tracking

Freshpaint supports view through tracking by capturing the `viant_impid` passed in by Viant using the Freshpaint Impression Pixel. Assuming you have followed the [viant-quick-start-guide](https://documentation.freshpaint.io/integrations/destinations/demand-side-platforms-dsps/viant/viant-quick-start-guide "mention") to set up your Viant destination, you can verify that view through tracking is working by looking for an event in event verification that contains the `$viant_impid` field, similar to how you can verify Click Through Conversion.

You can also look for a transformation that shows that the event data was enriched by the Freshpaint Impression Pixel.

<div data-full-width="true"><figure><img src="https://1666823438-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2F-MA7aDqsXMFbUsWVqonF%2Fuploads%2FkQsjkR6r4PBNa4LHMMAO%2FScreenshot%202024-11-15%20at%202.47.01%E2%80%AFPM.png?alt=media&#x26;token=416cfad9-e1f9-4f44-9a37-b3c82f43feb8" alt=""><figcaption><p>Transformation applying the Impression Pixel captured impression to an event</p></figcaption></figure></div>

## Relevant Properties

These are the properties that are sent to Viant. If you've followed the [viant-quick-start-guide](https://documentation.freshpaint.io/integrations/destinations/demand-side-platforms-dsps/viant/viant-quick-start-guide "mention") correctly, no further action is necessary. This section is just informational.

<table data-header-hidden data-full-width="true"><thead><tr><th width="207"></th><th width="214"></th><th width="137"></th><th></th></tr></thead><tbody><tr><td><strong>Freshpaint property</strong></td><td><strong>Viant</strong><br><strong>parameter</strong></td><td><strong>Type</strong></td><td><strong>Description</strong></td></tr><tr><td><code>$viant_clid</code></td><td><code>xid</code></td><td>string</td><td>This is the Viant Click ID that is captured by the Freshpaint tracker on the landing page configured on the creative. This is a required property, but can be empty if it's a view through conversion. This takes priority over the view impression ID.</td></tr><tr><td><code>$viant_impid</code></td><td><code>imp_id</code></td><td>string</td><td>This is the Viant View Impression ID. This property is captured by the Freshpaint Impression Pixel, and is passed to Freshpaint via the tracking pixel configured on the creative. This is a required property, but can be empty if it is a click through conversion.</td></tr><tr><td><code>&#x3C;event_name></code></td><td><code>ci_t_event_name</code> <br><code>p_event_name</code></td><td>string</td><td>Event name property for Viant. Freshpaint automatically sets both Viant parameters to the event name.</td></tr><tr><td><code>&#x3C;advertiser_id></code></td><td><code>c_advertiser_id</code></td><td>numeric string</td><td>This is your Viant Advertiser ID that you configure on Freshpaint when setting up the destination. Required.</td></tr><tr><td><code>&#x3C;event_time></code></td><td><code>p_event_time</code></td><td>number</td><td>This is the event time represented in ms since epoch. Automatically set by Freshpaint.</td></tr><tr><td>-</td><td><code>ci_t_vendor</code></td><td>string</td><td>Hardcoded to <code>freshpaint</code>. Automatically set by Freshpaint.</td></tr><tr><td>-</td><td><code>ci_t_action</code></td><td>string</td><td>Hardcoded to <code>tx_created</code>. Automatically set by Freshpaint.</td></tr></tbody></table>