Viant VDP Conversion API Connector Setup Guide
This article describes how to set up the Viant VDP Conversion API connector.
API Information
This connector uses the following vendor API:
- API Name: Viant API
- API Version: v1
- API Endpoint:
https://vdp-connect-api.viantinc.com - Documentation: Viant API
Configuration
Go to the Connector Marketplace and add a new connector. For general instructions on how to add a connector, see About Connectors.
After adding the connector, configure the following settings:
- Client ID: Required. Client ID for Viant VDP API authentication.
- Client Secret: Required. Client secret for Viant VDP API authentication.
- Account ID: Required. Viant account ID.
- Advertiser ID: Required. Viant advertiser ID.
Actions
| Action Name | AudienceStream | EventStream |
|---|---|---|
| Send Conversion Event | ✓ | ✓ | <<<<<<< Updated upstream =======
| Send Healthcare Conversion Event | ✓ | ✓ | >>>>>>> Stashed changes
Enter a name for the action and select the action type from the drop-down menu.
The following section describes how to set up parameters and options for each action.
Send Conversion Event
Batch Limits
This action uses batched requests to support high-volume data transfers to the vendor. Parallel processing may result in events reaching the vendor out of sequence. Add a sequence value to events if ordering is important. For more information, see Batched Actions. Requests are queued until one of the following thresholds is met or the profile is published:
- Max number of requests: 1,000
- Max time since oldest request: 10 minutes
- Max size of requests: 10 MB
Parameters
| Parameter | Description |
|---|---|
| Conversion Event Type | PageView - Page view event LandingPage - Landing page event ItemView - Item view event AddToCart - Add to cart event InitiateCheckout - Initiate checkout event AddPaymentInfo - Add payment info event Purchase - Purchase event Lead - Lead event |
Sales Data
| Parameter | Description |
|---|---|
| Transaction ID | Unique identifier for the transaction. Automapping applied, map attribute to override. |
| Conversion Timestamp | ISO 8601 timestamp of the conversion. For example, 2025-07-28T15:32:00Z. Automapping applied, map attribute to override. |
| Store ID | Unique identifier for the store or location. |
| Amount | Total conversion or transaction amount. Automapping applied, map attribute to override. |
| Currency | Currency code. For example, USD, EUR. Automapping applied, map attribute to override. |
| Sales Channel | Sales channel. For example, Online, In-store. |
Identifiers
| Parameter | Description |
|---|---|
| Email Apply SHA256 | Plain text email address of the customer. Connector will normalize and apply SHA256 Hashing. |
| Email Already SHA256 | SHA256 hashed customer email address. |
| Address Apply SHA256 | Plain text address of the customer. Connector will normalize and apply SHA256 Hashing. |
| Address Already SHA256 | SHA256 hashed customer address. |
| IP Address | Customer IP address. |
| Mobile ID | Customer mobile ID. |
| Cookie | Event cookie. |
Purchased Items
| Parameter | Description |
|---|---|
| Item ID | (Required if items present) Unique identifier for the product SKU. |
| Product Name | Human-readable name of the product. |
| Product Category | Category of the product. |
| Price | (Required if items present) Price per unit. |
| Quantity | (Required if items present) Quantity purchased. |
| Custom Data | Up to 10 custom key-value metadata pairs for any additional context. For example, campaign IDs, user segments. |
Conversion Location
| Parameter | Description |
|---|---|
| Conversion Country | The country of the conversion location. |
| Conversion State | The state of the conversion location. |
| Conversion City | The city of the conversion location. |
| Disable Automapping | Disable automatic mapping for the connector. |
Send Healthcare Conversion Event
Batch Limits
This action uses batched requests to support high-volume data transfers to the vendor. Parallel processing may result in events reaching the vendor out of sequence. Add a sequence value to events if ordering is important. For more information, see Batched Actions. Requests are queued until one of the following thresholds is met or the profile is published:
- Max number of requests: 1,000
- Max time since oldest request: 10 minutes
- Max size of requests: 10 MB
Parameters
| Parameter | Description |
|---|---|
| Healthcare Event Name | (Required) The anonymized event code to send to Viant. For example, Page View, Event 1, Event 2. Use short opaque codes rather than descriptive event names to comply with HIPAA requirements. |
Sales Data
| Parameter | Description |
|---|---|
| Transaction ID | (Required) Unique identifier for the transaction. Used to group Impression ID and Click ID. |
| Conversion Timestamp | ISO 8601 timestamp of the conversion. For example, 2025-07-28T15:32:00Z. Current time used if not provided. |
| Store ID | Unique identifier for the store or location. |
| Sales Channel | Sales channel. For example, Online, In-store. |
Healthcare Identifiers
| Parameter | Description |
|---|---|
| Viant Impression ID | Viant pseudonymous impression tracking ID from the creative macro ${ADELPHIC_IMPRESSIONID}. Used for post-view conversion attribution. |
| Viant Click ID | Viant pseudonymous click tracking ID from the creative macro ${ADELPHIC_CLICKID}. Used for post-click conversion attribution. |
| Custom Identifier | (Optional) A customer-defined pseudonymous key. For example, internal encounter or funnel ID. |
| Custom Data | (Optional) Key-value metadata pairs for additional context. The healthcare_capi flag is automatically included. |
Conversion Location
| Parameter | Description |
|---|---|
| Conversion Country | The country of the conversion location. |
| Conversion State | The state of the conversion location. |
| Conversion City | The city of the conversion location. |
This page was last updated: April 22, 2026 =======
This page was last updated: June 22, 2026 >>>>>>> Stashed changes