Explore the Constant Contact API data model

See how the various Constant Contact endpoints relate to each other, using our handy Entity Relationship Diagram

Try our interactive ERD Or, read the docs below

Pulling data from the Constant Contact API is only the first part of your reporting. You also need to understand the relationships between different endpoints - something that APIs typically fail to convey.

At SyncHub, we not only sync your Constant Contact API endpoints down into a reportable format, we also describe their relationships (e.g. in terms of foreign keys) so that you can quickly get a grasp of your data and how it fits together. This page is intended as technical documentation of these relationships.

Endpoints

EmailCampaign

Column Type Relates to Notes
RemoteID string - -
WhenUpsertedIntoDataStore datetime - -
MirrorRemoteID int - -
IsDeleted boolean - -
WhenCreated datetime - -
WhenModified datetime - -
Name string - -
CampaignID guid - -
CreatedAt datetime - -
CurrentStatus string - -
Type string - -
UpdatedAt datetime - -

CampaignActivity

Column Type Relates to Notes
RemoteID string - -
WhenUpsertedIntoDataStore datetime - -
MirrorRemoteID int - -
IsDeleted boolean - -
WhenCreated datetime - -
WhenModified datetime - -
CampaignActivityID guid - -
CampaignID guid EmailCampaign → CampaignID -
Role string - -

Contact

Column Type Relates to Notes
RemoteID string - -
WhenUpsertedIntoDataStore datetime - -
MirrorRemoteID int - -
IsDeleted boolean - -
WhenCreated datetime - -
WhenModified datetime - -
ContactID guid - -
FirstName string - -
LastName string - -
JobTitle string - -
CompanyName string - -
BirthdayMonth int - -
BirthdayDay int - -
Anniversary datetime - -
UpdateSource string - -
CreateSource string - -
CreatedAt datetime - -
UpdatedAt datetime - -
DeletedAt datetime - -
Email string - -
EmailPermissionToSend string - -
EmailOptInSource string - -
EmailOptInDate datetime - -
EmailOptOutSource string - -
EmailOptOutDate datetime - -
EmailOptOutReason string - -
EmailConfirmStatus string - -

ContactListMembership

Column Type Relates to Notes
RemoteID string - -
ContactRemoteID string Contact → RemoteID -
WhenUpsertedIntoDataStore datetime - -
MirrorRemoteID int - -
IsDeleted boolean - -
WhenCreated datetime - -
WhenModified datetime - -
ContactID guid Contact → ContactID -
ContactListID guid ContactList → ListID -

ContactCustomField

Column Type Relates to Notes
RemoteID string - -
ContactRemoteID string Contact → RemoteID -
WhenUpsertedIntoDataStore datetime - -
MirrorRemoteID int - -
IsDeleted boolean - -
WhenCreated datetime - -
WhenModified datetime - -
ContactID guid Contact → ContactID -
CustomFieldID guid - -
Value string - -

ContactList

Column Type Relates to Notes
RemoteID string - -
WhenUpsertedIntoDataStore datetime - -
MirrorRemoteID int - -
IsDeleted boolean - -
WhenCreated datetime - -
WhenModified datetime - -
Name string - -
ListID guid - -
Favorite boolean - -
CreatedAt datetime - -
UpdatedAt datetime - -
MembershipCount int - -

CustomField

Column Type Relates to Notes
RemoteID string - -
WhenUpsertedIntoDataStore datetime - -
MirrorRemoteID int - -
IsDeleted boolean - -
WhenCreated datetime - -
WhenModified datetime - -
Name string - -
CustomFieldID guid - -
Label string - -
Type string - -
UpdatedAt datetime - -
CreatedAt datetime - -

BounceEvent

Column Type Relates to Notes
RemoteID string - -
CampaignActivityRemoteID string CampaignActivity → RemoteID -
WhenUpsertedIntoDataStore datetime - -
MirrorRemoteID int - -
IsDeleted boolean - -
WhenCreated datetime - -
WhenModified datetime - -
BounceCode string - -
CurrentEmailAddress string - -
CampaignActivityID guid CampaignActivity → CampaignActivityID -
TrackingActivityType string - -
ContactID guid Contact → ContactID -
EmailAddress string - -
FirstName string - -
LastName string - -
CreatedTime datetime - -

ClickEvent

Column Type Relates to Notes
RemoteID string - -
CampaignActivityRemoteID string CampaignActivity → RemoteID -
WhenUpsertedIntoDataStore datetime - -
MirrorRemoteID int - -
IsDeleted boolean - -
WhenCreated datetime - -
WhenModified datetime - -
DeviceType string - -
UrlID string - -
LinkUrl string - -
CampaignActivityID guid CampaignActivity → CampaignActivityID -
TrackingActivityType string - -
ContactID guid Contact → ContactID -
EmailAddress string - -
FirstName string - -
LastName string - -
CreatedTime datetime - -

DidNotOpenEvent

Column Type Relates to Notes
RemoteID string - -
CampaignActivityRemoteID string CampaignActivity → RemoteID -
WhenUpsertedIntoDataStore datetime - -
MirrorRemoteID int - -
IsDeleted boolean - -
WhenCreated datetime - -
WhenModified datetime - -
CampaignActivityID guid CampaignActivity → CampaignActivityID -
TrackingActivityType string - -
ContactID guid Contact → ContactID -
EmailAddress string - -
FirstName string - -
LastName string - -
CreatedTime datetime - -

ForwardEvent

Column Type Relates to Notes
RemoteID string - -
CampaignActivityRemoteID string CampaignActivity → RemoteID -
WhenUpsertedIntoDataStore datetime - -
MirrorRemoteID int - -
IsDeleted boolean - -
WhenCreated datetime - -
WhenModified datetime - -
CampaignActivityID guid CampaignActivity → CampaignActivityID -
TrackingActivityType string - -
ContactID guid Contact → ContactID -
EmailAddress string - -
FirstName string - -
LastName string - -
CreatedTime datetime - -

OptOutEvent

Column Type Relates to Notes
RemoteID string - -
CampaignActivityRemoteID string CampaignActivity → RemoteID -
WhenUpsertedIntoDataStore datetime - -
MirrorRemoteID int - -
IsDeleted boolean - -
WhenCreated datetime - -
WhenModified datetime - -
OptOutReason string - -
CampaignActivityID guid CampaignActivity → CampaignActivityID -
TrackingActivityType string - -
ContactID guid Contact → ContactID -
EmailAddress string - -
FirstName string - -
LastName string - -
CreatedTime datetime - -

SendEvent

Column Type Relates to Notes
RemoteID string - -
CampaignActivityRemoteID string CampaignActivity → RemoteID -
WhenUpsertedIntoDataStore datetime - -
MirrorRemoteID int - -
IsDeleted boolean - -
WhenCreated datetime - -
WhenModified datetime - -
CampaignActivityID guid CampaignActivity → CampaignActivityID -
TrackingActivityType string - -
ContactID guid Contact → ContactID -
EmailAddress string - -
FirstName string - -
LastName string - -
CreatedTime datetime - -

OpenEvent

Column Type Relates to Notes
RemoteID string - -
CampaignActivityRemoteID string CampaignActivity → RemoteID -
WhenUpsertedIntoDataStore datetime - -
MirrorRemoteID int - -
IsDeleted boolean - -
WhenCreated datetime - -
WhenModified datetime - -
DeviceType string - -
CampaignActivityID guid CampaignActivity → CampaignActivityID -
TrackingActivityType string - -
ContactID guid Contact → ContactID -
EmailAddress string - -
FirstName string - -
LastName string - -
CreatedTime datetime - -

ContactPhoneNumber

Column Type Relates to Notes
RemoteID string - -
ContactRemoteID string Contact → RemoteID -
WhenUpsertedIntoDataStore datetime - -
MirrorRemoteID int - -
IsDeleted boolean - -
WhenCreated datetime - -
WhenModified datetime - -
ContactID guid Contact → ContactID -
PhoneNumberID guid - -
PhoneNumber string - -
Kind string - -
CreatedAt datetime - -
UpdatedAt datetime - -
UpdateSource string - -
CreateSource string - -

ContactStreetAddress

Column Type Relates to Notes
RemoteID string - -
ContactRemoteID string Contact → RemoteID -
WhenUpsertedIntoDataStore datetime - -
MirrorRemoteID int - -
IsDeleted boolean - -
WhenCreated datetime - -
WhenModified datetime - -
ContactID guid Contact → ContactID -
StreetAddressID guid - -
Kind string - -
Street string - -
City string - -
State string - -
PostalCode string - -
Country string - -
CreatedAt datetime - -
UpdatedAt datetime - -

Need more?

SyncHub lives and breathes APIs and data. Keep exploring using the links below.

Connect your own Constant Contact data Interactive ERD Querying Constant Contact using regular SQL