Visit Object
Use visit resources to learn about a user visit to your website. Discover the user's Account Engagement ID, Google Analytics parameters, and other information.
The API to access the Visit object follows the conventions described in Version 5 Overview.
| Operation | HTTP Verb | URL Format | Ability Requirements |
|---|---|---|---|
| Read | GET | https://pi.pardot.com/api/v5/objects/visits/<id>?<params> | Prospect > Prospects > View ability |
| Query | GET | https://pi.pardot.com/api/v5/objects/visits?<params> | Prospect > Prospects > View ability |
| Field | Type | Description |
|---|---|---|
id | Integer | ID of the object. |
visitorId | Integer | Account Engagement ID for the associated visitor. |
prospectId | Integer | Account Engagement ID for the associated prospect. |
visitorPageViewCount | Integer | Number of page views for this visit. |
firstVisitorPageViewAt | DateTime | Time of first page view for this visit; Time is reported in API user's preferred timezone. |
lastVisitorPageViewAt | DateTime | Time of last page view for this visit; Time is reported in API user's preferred timezone. |
durationInSeconds | Integer | Length of this visit. |
campaignParameter | String | Visit's campaign parameter utm_campaign from Google Analytics. |
mediumParameter | String | Visit's medium parameter utm_medium from Google Analytics. |
sourceParameter | String | Visit's source parameter utm_source from Google Analytics. |
contentParameter | String | Visit's content parameter utm_content from Google Analytics. |
termParameter | String | Visit's term parameter utm_term from Google Analytics. |
createdAt | DateTime | Creation time of this object. |
updatedAt | DateTime | Last updated time for the object. |
prospect | Prospect | Prospect object representing the prospect related to this object. See documentation for Prospect for fields. |
Retrieve a single visit following the conventions described in the Version 5 Overview.
Example request:
Example response:
Retrieving a collection of visit 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.
idprospectIdcreatedAtupdatedAt
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.
| Parameter | Description |
|---|---|
id | Returns any visit where ID is equal to the given integer value. |
idList | Returns any visit where ID is included in the given list of values. |
idGreaterThan | Returns any visit where ID is greater than the specified value, non-inclusive. |
idGreaterThanOrEqualTo | Returns any visit where ID is greater than or equal to the specified value. |
idLessThan | Returns any visit where ID is less than the specified value, non-inclusive. |
idLessThanOrEqualTo | Returns any visit where ID is less than or equal to the specified value. |
visitorId | Returns any visit where VisitorId is equal to the given integer value. |
visitorIdGreaterThan | Returns any visit where VisitorId is greater than the specified value, non-inclusive. |
visitorIdGreaterThanOrEqualTo | Returns any visit where VisitorId is greater than or equal to the specified value. |
visitorIdLessThan | Returns any visit where VisitorId is less than the specified value, non-inclusive. |
visitorIdLessThanOrEqualTo | Returns any visit where VisitorId is less than or equal to the specified value. |
prospectId | Returns any visit where ProspectId is equal to the given integer value. |
prospectIdGreaterThan | Returns any visit where ProspectId is greater than the specified value, non-inclusive. |
prospectIdGreaterThanOrEqualTo | Returns any visit where ProspectId is greater than or equal to the specified value. |
prospectIdLessThan | Returns any visit where ProspectId is less than the specified value, non-inclusive. |
prospectIdLessThanOrEqualTo | Returns any visit where ProspectId is less than or equal to the specified value. |
createdAt | Returns any visit where CreatedAt is equal to the given datetime value. |
createdAtAfter | Returns any visit where CreatedAt is after the given datetime value, non-inclusive. |
createdAtAfterOrEqualTo | Returns any visit where CreatedAt is after or equal to the given datetime value. |
createdAtBefore | Returns any visit where CreatedAt is before the given datetime value, non-inclusive. |
createdAtBeforeOrEqualTo | Returns any visit where CreatedAt is before or equal to the given datetime value. |
updatedAt | Returns any visit where UpdatedAt is equal to the given datetime value. |
updatedAtAfter | Returns any visit where UpdatedAt is after the given datetime value, non-inclusive. |
updatedAtAfterOrEqualTo | Returns any visit where UpdatedAt is after or equal to the given datetime value. |
updatedAtBefore | Returns any visit where UpdatedAt is before the given datetime value, non-inclusive. |
updatedAtBeforeOrEqualTo | Returns any visit where UpdatedAt is before or equal to the given datetime value. |
Example request:
Example response: