REST API - Accessing Contact Activities

Version 2

    The REST API allows access to activity data for known contacts.

     

    Accessing Activities

    • GET   /data/activities/contact/{id}?startDate={startDate}&endDate={endDate}&type={type}&count={count}

     

    Response

    The response for this call looks as follows :

     

    [
      {
        "type": "Activity",
        "activityDate": "1309459305",
        "activityType": "emailSend",
        "asset": "2465",
        "assetType": "email",
        "contact": "380458",
        "details": [
          {
            "Key": "EmailWebLink",
            "Value": ""
          },
          {
            "Key": "EmailName",
            "Value": "Eloqua Sample Email"
          },
          {
            "Key": "EmailRecipientID",
            "Value": "13830d8a-3f22-420a-84f9-5d31305a1cc1"
          },
          {
            "Key": "SubjectLine",
            "Value": "Sample Test"
          }
        ],
        "id": "47837"
      }
    ]
     

     

    Properties

     

    Name

    Type

    Description

    Notes

    Validations

    type"Activity"
    activityDateintegerThe date of the activityIntegerRequirement
    activityTypeActivityTypeThe type of activityEnumRequirement
    assetintegerIdRequirement
    assetTypeActivityAssetTypeEnumRequirement
    contactintegerThe id of the contact who performed the activityIdRequirement
    detailsList
    <string, string>
    A list of details related to the activity
    idstringThe unique identifier of the activity

     

    Activity Asset Types

    • campaign
    • email
    • form
    • web

     

    Activity Type Details

    • campaign
      • campaignMembership
        • Responded
        • CampaignName
        • LeadStage
    • email
      • emailClickThrough
        • EmailClickedThruLink
        • EmailName
        • EmailWebLink
        • EmailRecipientId
        • SubjectLine
      • emailOpen
        • EmailName
        • EmailWebLink
        • EmailRecipientId
        • IPAddress
        • SubjectLine
      • emailSend
        • EmailName
        • EmailWebLink
        • EmailRecipientId
        • SubjectLine
      • emailSubscribe
        • CampaignName
        • EmailCampaignId
      • emailUnsubscribe
        • CampaignName
        • EmailCampaignId
    • form
      • formSubmit
        • Collection
        • FormName
    • web
      • webVisit
        • Duration
        • QueryString
        • QueryStringDisplay
        • Thread

     

    Related Operations

    • none

     

    Sample Code