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

Learn more about visitor activities in Salesforce Help.

The API to access the Visitor Activity object follows the conventions described in Version 5 Overview.

Retrieve a single visitor activity following the conventions described in the Version 5 Overview.

Example request:

Example response:

Retrieving a collection of visitor activities follows the conventions described in Version 5 Overview.

When executing a query, the following fields can be specified in the orderBy parameter. See the conventions for query described in the Version 5 Overview.

• id
• createdAt
• updatedAt

Example request:

Example response:

When executing a query, the following parameters can be used to filter the returned results. These parameters can be specified in the request along with any shared parameters defined in Version 5 Overview. When specifying more than one parameter, all parameters must match the record in order for it to be returned in the results.

Example request:

Example response:

Account Engagement creates an activity when a visitor or prospect interacts with a web page, such as viewing a form or clicking an advertisement. A web activity can have the following values for the type field:

• 1 (Click)
• 2 (View)
• 3 (Error)
• 4 (Success)
• 5 (Visitor/Session)
• 7 (Search)
• 20 (Visit)
• 21 (Custom URL Click)

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 typeName = Form. The visitor activity representation for this record contains the name of the form ("Event Registration") and the formId.

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:

• 1 (Click)
• 6 (Sent)
• 11 (Open)
• 12 (Unsubscribe Open)
• 13 (Bounce)
• 14 (Spam Complaint)
• 15 (Email Preference Open)
• 16 (Opt In)
• 17 (Third Party Click)
• 35 (Indirect Unsubscribe Open)
• 36 (Indirect Bounce)
• 37 (Indirect Opt In)

The information in the details field and the emailId field give you information about the email activity. If the email is sent as part of a list email, the list ID returns in the listEmailId field. If the email is created from a template, the template ID returns in the emailTemplateId field.

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

• The URL of the link in the details field.
• The ID of the email in the emailId field.
• The ID of the list from which the email was sent, in the listEmailId field.
• The ID of the template used to create the email, in the emailTemplateId field.

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