Email View

An event that describes the action of viewing an email.

Here's an example of a Email View:

Javascript

pcdp("event", "track", {
  "clientId": "kevel",
  "siteId": "kevel.com",
  "type": "emailView",
  "customFields": {
    "debug": "true",
    "role": "superuser"
  },
  "campaignId": "MAILCHIMP_KEVEL_456"
})

Swift

import VelocidiSDK

let trackingEvent = [
  "clientId": "kevel",
  "siteId": "kevel.com",
  "type": "emailView",
  "customFields": [
    "debug": "true",
    "role": "superuser"
  ],
  "campaignId": "MAILCHIMP_KEVEL_456"
] as [String: Any]

VSDKVelocidi.sharedInstance().track(trackingEvent, userId: userId)

Kotlin

@import VelocidiSDK;

NSDictionary *trackingEvent = @{
  @"clientId" : @"kevel",
  @"siteId" : @"kevel.com",
  @"type" : @"emailView",
  @"customFields" : @{
    @"debug" : @"true",
    @"role" : @"superuser"
  },
  @"campaignId" : @"MAILCHIMP_KEVEL_456"
};

[VSDKVelocidi.sharedInstance track: trackingEvent userId: userId]

Java

import org.json.*
import com.velocidi.Velocidi

val trackingEvent = mapOf(
  "clientId" to "kevel",
  "siteId" to "kevel.com",
  "type" to "emailView",
  "customFields" to mapOf(
    "debug" to "true",
    "role" to "superuser"
  ),
  "campaignId" to "MAILCHIMP_KEVEL_456"
)

Velocidi.getInstance().track(userId, JSONObject(trackingEvent))

Objective-C

import org.json.*;
import com.velocidi.Velocidi;

JSONObject trackingEvent = new JSONObject()
  .put("clientId", "kevel")
  .put("siteId", "kevel.com")
  .put("type", "emailView")
  .put("customFields", new JSONObject()
    .put("debug", "true")
    .put("role", "superuser")
  )
  .put("campaignId", "MAILCHIMP_KEVEL_456");

Velocidi.getInstance().track(userId, trackingEvent);

In more detail, the fields supported on every Email View are:

Field	Required	Type	Default	Example	Description
clientId		string		"kevel"	The client identifier.
siteId		string		"kevel.com"	The client's site identifier.
type	required	"emailView"		"emailView"	The event type.
customFields		object of string		{...}	An object with custom fields for extra metadata to be supplied in the event. The values within this object must all be strings.
facebookConversionTracking		Facebook Conversion Tracking Details		{...}	A description of a tracking event to send to Facebook using Facebook Conversions API.
campaignId		string		"MAILCHIMP_KEVEL_456"	The identifier of the advertising campaign associated with the email that was viewed.

Facebook Conversion Tracking Details

A description of a tracking event to send to Facebook using Facebook Conversions API.

Field	Required	Type	Default	Example	Description
pixel_id		string		"396622227884531"	The pixel ID to associate this Facebook tracking event with.
event_id		string		"0c53d0b57"	ID used to deduplicate events sent by both Facebook Pixel and Conversions API. More information about the usefulness of this ID is available at https://developers.facebook.com/docs/marketing-api/server-side-api/using-the-api/deduplicate-pixel-and-server-side-events.
event_name		string		"AddToCart"	A Facebook pixel Standard Event or Custom Event name. This field is used to deduplicate events sent by both Facebook Pixel and Conversions API. The available Standard Events are listed in https://developers.facebook.com/docs/facebook-pixel/reference#standard-events.
custom_data		object		{...}	Parameters to send additional data Facebook can use for ads delivery optimization. More information about the fields that can be supplied here is available at https://developers.facebook.com/docs/marketing-api/conversions-api/parameters/custom-data.