Activity detail values

Version 1.0

The table below lists all contact activity detail values retrieved using the GET /api/REST/1.0/data/activities/contact/{id} endpoint.

Retrieve all campaignMembership activities associated with contact id #1 in the given time frame:

GET api/rest/1.0/data/activities/contact/1?type=campaignMembership&startDate=1262304000&endDate=1531924526

Request response:

[
  {
    "type": "CampaignActivity",
    "activityDate": "1469719163",
    "activityType": "campaignMembership",
    "asset": "54",
    "assetType": "campaign",
    "contact": "1",
    "details": [
      {
        "Key": "Responded",
        "Value": "Yes"
      },
      {
        "Key": "CampaignName",
        "Value": "EMEA Q1/16 Breakfast Roadshow"
      },
      {
        "Key": "LeadStage",
        "Value": "Prospect"
      },
      {
        "Key": "ActivityType",
        "Value": "EmailsSent"
      },
      {
        "Key": "AssetType",
        "Value": "Emails"
      },
      {
        "Key": "AssetId",
        "Value": "103"
      },
      {
        "Key": "CampaignId",
        "Value": "54"
      }
    ],
    "id": "54",
    "hasResponded": "true"
  }
]
Asset type Activity type Detail Name Description
campaign campaignMembership Responded Whether the contact has entered a campaign and met a response rule
CampaignName The campaign asset's name
LeadStage The contact's current stage in the marketing funnel
email emailClickThrough EmailClickedThruLink The URL within the email the contact clicked
EmailName The email asset's name
EmailWebLink The URL to the online version of the email
EmailRecipientId The ID of the email recipient
SubjectLine The email asset's subject line
DeploymentId The ID associated with the email deployment
emailOpen EmailName The email asset's name
EmailWebLink The URL to the online version of the email
EmailRecipientId The ID of the email recipient
IPAddress The IP Address where the email was opened
SubjectLine The email asset's subject line
DeploymentId The ID associated with the email deployment
emailSend EmailName The email asset's name
EmailWebLink The URL to the online version of the email
EmailRecipientId The ID of the email recipient
SubjectLine The email asset's subject line
DeploymentId The ID associated with the email deployment
emailSubscribe CampaignName The campaign asset's name
EmailCampaignId The ID of the email group
emailUnsubscribe CampaignName The campaign asset's name
EmailCampaignId The ID of the email group
form formSubmit Collection A collection of form field data submitted
FormName The form asset's name
web webVisit Duration Length of time spent on the web visit
QueryString Query string of the visited URL.
QueryStringDisplay Display name of the query string parameter
URL The URL visited
Thread The thread ID of the web visit

Version 2.0

The table below lists all contact activity detail values retrieved using the GET/api/REST/2.0/data/activities/contact/{id} endpoint.

Asset type Activity type Detail Name Description
campaign campaignMembership Responded Whether the contact has entered a campaign and met a response rule
CampaignName The campaign asset's name
LeadStage The contact's current stage in the marketing funnel
email emailClickThrough EmailClickedThruLink The URL within the email the contact clicked
EmailName The email asset's name
EmailWebLink The URL to the online version of the email
EmailRecipientId The ID of the email recipient
SubjectLine The email asset's subject line
DeploymentId The ID associated with the email deployment
emailOpen EmailName The email asset's name
EmailWebLink The URL to the online version of the email
EmailRecipientId The ID of the email recipient
IPAddress The IP Address where the email was opened
SubjectLine The email asset's subject line
DeploymentId The ID associated with the email deployment
emailSend EmailName The email asset's name
EmailWebLink The URL to the online version of the email
EmailRecipientId The ID of the email recipient
SubjectLine The email asset's subject line
DeploymentId The ID associated with the email deployment
emailSubscribe CampaignName The campaign asset's name
EmailCampaignId The ID of the email group
emailUnsubscribe CampaignName The campaign asset's name
EmailCampaignId The ID of the email group
form formSubmit Collection A collection of form field data submitted
FormName The form asset's name
web webVisit Duration Length of time spent on the web visit
QueryString Query string of the visited URL.
QueryStringDisplay Display name of the query string parameter
URL The URL visited
Thread The thread ID of the web visit

sms

smsSend

Purpose

The SMS asset’s purpose (Transactional/Promotional)

SmsCode

Sender codes

smsDelivery

Purpose

The SMS asset’s purpose (Transactional/Promotional)

SmsCode

Sender codes

SmsDeliveredId

SMS delivery ID

smsClickThrough

 

Purpose

The SMS asset’s purpose (Transactional/Promotional)

SmsClickedThroughLink

Clicked URL

smsReply

Purpose

The SMS asset’s purpose (Transactional/Promotional)

SmsCode

Sender codes

Keyword

SMS keyword

smsBounceback

Purpose

The SMS asset’s purpose (Transactional/Promotional)

DRStatusCodeDescription

Description of the delivery receipt, from carrier

Category

Type of bounceback (Soft/Hard)

smsFail

SmsCode

Sender codes

Error

Error description

smsSubscribe

NA

smsUnsubscribe

NA

Learn more

Retrieve a list of activities (Application API)

Retrieve a list of activity field definitions (Bulk API)

Activity fields

Application API