Predictive Custom Fields

Salesforce.com provides programmatic access to your organization’s information using simple, powerful, and secure application programming interfaces. This API documentation is a superset to the basic Salesforce API documentation and covers the PAM namespace only.

The PAM namespace is defined as all Salesforce custom objects and fields created with the install of the Predictive AM Managed Package. To use this document, you should have a basic familiarity with software development, Web services, and the Salesforce user interface.

Any functionality described in this guide is available if your organization has the API feature enabled and the Predictive AM Managed Package installed. This feature is enabled by default for Unlimited, Enterprise, and Developer Editions. Some Professional Edition organizations may also have the API enabled. If you cannot access the features you see in this guide, contact support@predictiveresponse.com.

Reference: Click here to access the SOAP API Developer’s Guide – the general Salesforce API guide that provides access on Salesforce standard objects and methods.

Predictive Campaign Page
Predictive Email Edition Statistics
Predictive Click Throughs
Predictive Email History
Predictive Subscription Fields
Predictive Campaign Members
Predictive Leads/Contacts
Predictive Subscriber Choices

Predictive Campaign Page

Field Label	API Name	Field Type	Description
Inactive Members	PAM__Inactive_Members__c	Formula	Members that cannot be sent emails
Active Members	PAM__Active_Members__c	Roll-Up Summary	Members that have been synced with Predictive and can be sent campaign emails.
Total Members	PAM__Total_Members__c	Formula	NumberofLeads + NumberofContacts – NumberofConvertedLeads
Clicked to Open Rate	PAM__Click_to_Open_Rate__c	Formula	# members that clicked at least one link in an email / # members that opened an email
Completed to Open Rate	PAM__Completion_to_Open_Rate__c	Formula	# members that clicked to the defined completion page / # members that opened an email
Delivered Total	PAM__Delivered__c	Formula	Accumulated # of emails that have been sent and not bounced. For Scheduled campaigns, this refers to the current edition.
Delivered Rate	PAM__Delivery_Rate__c	Formula	# of emails delivered / # emails sent and not bounced
Opt Out Direct	PAM__Opt_Out_Rate__c	Roll-Up Summary	# of members that have clicked the global unsubscribe link from one of the emails in this campaign
Opt Out Indirect	PAM__Opt_Out_Indirect__c	Roll-Up Summary	# members that have opted out from an email in another campaign, after being added to this campaign
Complaints	PAM__Complaints_Rollup__c	Roll-Up Summary	Campaign members that submitted complaints via Yahoo, AOL or other feedback loop in this campaign. A complaint auto-generates an opt out and will also be included in the Opt Out Direct count.
Bounced	PAM__Bounced__c	Roll-Up Summary	Emails with hard bounces or re-occurring soft bounces in this campaign.
Opt Out Direct Rate	PAM__Opt_Out_Direct_Rate__c	Formula	# members that have opted out in this campaign / # emails delivered.
Opt Out Indirect Rate	PAM__Opt_Out_Indirect_Rate__c	Formula	# members that have opted out in another campaign after being added to this campaign / # emails delivered.
Complaint Rate	PAM__Complaint_Rate__c	Formula	# members that have submitted complaints in this campaign / # emails delivered.
Bounced Rate	PAM__Bounce_Rate__c	Formula	# Emails with hard bounces or re-occurring soft bounces in this campaign / # emails sent.

Back to Top

Predictive Email Edition Statistics

FIELD LABEL	API NAME	FIELD TYPE	DESCRIPTION
Sent	PAM__Sent__c	Number	# of emails that have been sent for this edition.
Delivered	PAM__Delivered__c	Formula	Unique # emails that have been sent and not bounced.
Opened	PAM__Unique Opens__c	Number	Unique # of emails that have been opened at least once in this edition.
Clicked	PAM__Unique_Clicks__c	Number	Unique # of emails where at least one link has been clicked
Completed	PAM__Unique_Completions__c	Number	Unique # of members that have clicked your defined completion page.
Delivered Rate	PAM__Delivery_Rate__c	Formula	Unique # emails that have been sent and not bounced / # emails sent
Open Rate	PAM__Open_Rate__c	Formula	Unique # of emails that have been opened at least once in this edition / # emails delivered.
Click Rate	PAM__Click_Rate__c	Formula	Unique # of emails where at least one link has been clicked / # emails delivered
Complete Rate	PAM__Completion_Rate__c	Formula	Unique # of members that have clicked your defined completion page / # emails delivered.
Opt Out Direct	PAM__Opt_Out__c	Number	Members that have opted out in this edition.
Opt Out Indirect	PAM_Opt_Out_Indirect__c	Formula	Members that have opted out in another campaign, after being added to this campaign
Bounced	PAM__Bounced__c	Formula	# Emails with hard bounces or re-occurring soft bounces in this edition
Complaints	PAM__Complaints__c	Number	Campaign members that submitted complaints via Yahoo, AOL or other feedback loop in this edition. A complaint auto-generates an opt out and will also be included in the Opt Out Direct count.
Opt Out Direct Rate	PAM_Opt_Out_Rate__c	Formula	Members that have opted out in this edition / # emails delivered.
Opt Out Indirect Rate	PAM__Opt_Out_Indirect_Rate__c	Formula	Members that have opted out in another campaign, after being added to this campaign / # emails delivered.
Bounce Rate	PAM__Bounce_Rate__c	Formula	# emails that bounced in this edition / # emails sent
Complaint Rate	PAM__Complaint_Rate__c	Formula	# members that have submitted complaints in this edition/ # emails delivered.
Campaign	PAM__Campaign__c	Master-Detail
External_Id	PAM__External_Id__c	Number
Subject	PAM__Subject__c	Text

Back to Top

Predictive Click Throughs

FIELD LABEL	API NAME	FIELD TYPE
Campaign	PAM__Campaign__c	Lookup
Email Edition	PAM__Email_Edition__c	Master-Detail
External_Id	PAM__External_Id__c	Number
Total Clicks	PAM__Total_Clicks__c	Number
Unique Clicks	PAM__Unique_Clicks__c	Number
URL	PAM__URL__c	URL

Predictive Email History

FIELD LABEL	API NAME	FIELD TYPE
Campaign	PAM__Campaign__c	Lookup
Edition Name	PAM__Email_Edition__c	Master-Detail
Subject	PAM__Subject__c	Text
Day of Week	PAM__Day_of_Week__c	Formula
Date/Hour	PAM__Date_Hour__c	Date/Time
Sent	PAM__Sent__c	Number
Opened	PAM__Opened__c	Number
Clicked	PAM__Clicked__c	Number
Completed	PAM_Completed__c	Number
External_Id	PAM__External_Id__c	Number

Back to Top

Predictive Subscription Fields

FIELD LABEL	API NAME	FIELD TYPE	DESCRIPTION
Description	PAM__Description__c	Text Area	Used in Subscription, Subscription Group, Subscription Page objects
Enabled	PAM__Enabled__c	Checkbox	Used in Subscription, Subscription Group objects
Group	PAM__Group__c	Master-Detail	Used in Subscription object
Sort	PAM__Sort__c	Text	Used in Subscription, Subscription Group objects
Subscription Page	PAM__SUbecription_Page__c	Master_Detail	Used in Subscription Group object
Label	PAM__Label__c	Text	Used in Subscription Page object
URL	PAM__URL__c	URL	Used in Subscription Page object

Back to Top

Predictive Campaign Member

FIELD LABEL	API NAME	FIELD TYPE	DESCRIPTION
Last Status Update	PAM__Inactive_Date__c	Date	Last Predictive Status update/activity date for this member
Level	PAM__Level_Description__C	Formula	Levels indicates the “Funnel Position” of the Member. Levels are Pending, Sent, Opened, Clicked or Completed.
Level Code	PAM__Level__c	Number	Numerical representation for the levels.
Level Code Null	PAM__Level_Code_Null__c	Formula
Reason	PAM__Reason_Description__c	Formula	Reason for not reaching the members inbox
Reason Code	PAM__Reason__c	Number	Numerical representation for the reasons.
Test Member	PAM__Is_Test_Member__c	Checkbox	Indicates that this member is an internal test member. Test Members will automatically be added to all new campaigns and will receive Predictive test emails.

Reference: For more information on levels and reasons, click here.

Back to Top

Predictive Leads/Contacts

FIELD LABEL	API NAME	FIELD TYPE	DESCRIPTION
Lead Score	PAM__Lead_Score__c	Number	Accumulated score from all campaigns – lead score write off%. Lead score is managed on the Manage window in Predictive and is based on opens, clicks and completions.
Lead Score Rating	PAM__Lead_Score_Rating__c	Formula	Predictive default scoring rating based on lead score
Test Member	PAM__Is_Test_Member_cc	Checkbox	If checked, this lead is automatically added to ALL campaigns as a test member and will receive all Predictive test emails. Used in lead and contact objects.
Test Group	PAM_Test_Group__c	Text	Used in lead and contact objects.
Contact Score	PAM__Contact_Score__c	Number	Accumulated score from all campaigns – contact score write off%. Contact score is managed on the Manage window in Predictive and is based on opens, clicks and completions.
Contact Score Rating	PAM__Contact_Score_Rating__c	Formula	Predictive default score rating based on contact score

Back to Top

Predictive Subscriber Choices

FIELD LABEL	API NAME	FIELD TYPE
Contact	PAM__Contact__c	Lookup
Created	PAM__Created__c	Date/Time
External_Id	PAM__External_Id__c	Number
Lead	PAM__Lead__c	Lookup
Status	PAM__Status__c	Picklist
Subscription	PAM__Subscription__c	Master-Detail

Back to Top

(0)