Visitor Activity Object

Use activities resources to learn how visitors and prospects have interacted with your website. Examples of activities include:

• viewing and clicking your website
• submitting a form
• clicking a social media post

For more information on the types of activities, see Visitor Activity. Learn more about visitor activities in Salesforce Help.

Returns information for the specified activity. Specify the activity by Account Engagement ID.

Return the information for the activity with Account Engagement ID 153879xxx.

Returns information about activities that match the specified criteria. You can specify which kinds of activities and which fields to return. A maximum of 200 activities are returned.

Use these parameters to specify which activities are returned. Parameters can be used in any combination and in any order unless specified otherwise.

For all requests:

• Parameters must be URL-encoded.
• Dates and times must use GNU Date Input Syntax, for example yyyy-mm-dd:hh:ss.

For a full listing of visitor activity fields, see Visitor Activity.

Use these parameters to request activities that are associated with a category of visitor or prospect action. For example, you can request activities created when prospects or visitors fill out a form.

Use these parameters to request activities that are related to a specific record. For example, you can request all activities that resulted from the "Spring Into Fall" campaign. We recommend using POST for this request.

You can specify multiple IDs in the same request. Separate IDs with a comma.

Use these parameters to specify which prospect or visitor fields are returned, and how the results are sorted.

You can control how the results are sorted using the sort_by and sort_order parameters.

To request activities associated with the prospects with Account Engagement IDs 1234xxx and 5678xxx, use this endpoint:

To request activities associated with files that resulted from a campaign with ID equal to 1234, use this endpoint:

The XML response to a visitor activity query request contains information for up to 200 activities. The XML response to a visitor activity read request contains information for the specified activity.

Account Engagement tracks many kinds of visitor and prospect activities, and these different kinds of activities contain different kinds of information. For example, an activity created when a prospect opens an email contains the subject and ID of the email. The activity created when a visitor views a landing page contains the name and ID of the landing page.

The XML response to every visitor activity request has the following general format:

Account Engagement creates an activity when a visitor or prospect interacts with a web page, for example by viewing a form or clicking an advertisement. This table shows the values that a web activity can have for the type field:

The information in the details field, and the name of the primary ID field, give you information about the web activity.

When a visitor or prospect fills out a form, Account Engagement creates an activity with type=2 (View) and type_name = Form. The XML response to a visitor activity request for this record contains the name of the form ("Event Registration"), and the form_id (387xx).

Account Engagement creates an activity when it sends an email, or when a visitor or prospect interacts with the email. An email activity can have the following values for the type field:

The information in the details field and the email_ID field give you information about the email activity. If the email was sent as part of a list email, the list ID is returned in list_email_id field. If the email was created from a template, the template ID is returned in the email_template_id field.

When a prospect clicks a link in an email, Account Engagement creates an activity with type type=1 and type_name = Email Tracker. The XML response to a visitor activity request for this record contains:

• The URL of the link in the details field.
• The ID of the email in the email_id field.
• The ID of the list from which the email was sent, in the list_email_id field.
• The ID of the template used to create the email, in the email_template_id.

Account Engagement creates an activity when an opportunity is created, or information on an opportunity changes. XML responses for opportunity activities contain a field called opportunity_id, which contains the ID of the Salesforce opportunity. Opportunity activities don’t contain a details field. An opportunity activity can have the following values for the type and type_name field: