Use visitor resources to learn about the people who interact with your website, including their IP address and Google Analytics information. A visitor is someone who has visited a page with your Account Engagement tracking code on it, but hasn’t converted to a prospect yet. Learn more about visitors in Salesforce Help.
The API to access the Visit object follows the conventions described in Version 5 Overview.
|Operation||HTTP Verb||URL Format||Ability Requirements|
|Read||Prospect > Visitors > View ability|
|Query||Prospect > Visitors > View ability|
|Assign to Prospect||Prospect > Visitors > View ability|
|Identify Company||Prospect > Visitors > View ability|
|Int||ID of the object.|
|String||Visitor's campaign parameter utm_campaign from Google Analytics.|
|String||Visitor's content parameter utm_content from Google Analytics.|
|DateTime||Time the object was created.|
|Boolean||Indicates whether the prospect, or a visitor associated with the propect, recorded an activity with the Global Privacy Control Header enabled.|
|String||Equivalent to visitor.hostname|
|String||Equivalent to visitor.ip_address|
|String||Visitor's medium parameter utm_medium from Google Analytics.|
|Int||Equivalent to visitor.visitor_page_view_count|
|Prospect||Account Engagement ID for the associated prospect.|
|Campaign||Campaign ID for the associated visitor.|
|String||Visitor's source parameter utm_source from Google Analytics.|
|String||Visitor's term parameter utm_term from Google Analytics.|
|Datetime||Last updated time for the object.|
|Boolean||If True, the visitor's company is identified.|
|True||Int||The ID of the prospect to be assigned to the Visitor.|
|False||Boolean||True if the visitor can be assigned to a deleted prospect. If the Prospect isn’t deleted, the value of this property isn’t used. Defaults to false.|
Retrieve a single visitor following the conventions described in the Version 5 Overview.
Retrieving a collection of visitors 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.
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.
|Returns any visit where ID is equal to the given integer.|
|Returns any visit where ProspectId is equal to the given integer.|
|Returns any visit where CreatedAt is equal to the given datetime.|
|Returns any visit where UpdatedAt is equal to the given datetime.|
|Determines whether to return deleted records. The value can be |
Assigns a visitor record to a prospect.
Visitor assigned to prospect successfully
Visitor not found
NOT FOUND (404)
Prospect not found
BAD REQUEST (400)
Prospect is deleted and “assignedDeletedProspect“ is false (or not defined)
- Status Code:
BAD REQUEST (400)
Returns information about the visitor's company, if identified.
If the visitor has an identified company, the request responds with the status
SUCCESS 200, and returns these fields:
|String||Company postal code|
If the visitor doesn’t have an identified company, the request responds with the status
NOT FOUND (404).