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.
Prospect object representing the prospect related to this object. See documentation for Prospect for fields.
Visit Read
Retrieve a single visit following the conventions described in the Version 5 Overview.
Example request:
GET /api/v5/objects/visits/101?fields=id,visitorId,prospectId
Host: pi.pardot.com
Authorization: Bearer <access-token>
Example response:
HTTP/1.1200 OK
Content-Type: application/json
{"id":101,"visitorId":344,"prospectId":239}
Visit Query
Retrieving a collection of visit follows the conventions described in Version 5 Overview.
Sortable Fields
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
prospectId
createdAt
updatedAt
Example request:
GET /api/v5/objects/visits?fields=id,visitorId,prospectId
Host: pi.pardot.com
Authorization: Bearer <access-token>
Example response:
HTTP/1.1200 OK
Content-Type: application/json
{"values":[{"id":101,"visitorId":344,"prospectId":239}]}
Filtering Results
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:
GET /api/v5/objects/visits?fields=id,visitorId&orderBy=id desc&idGreaterThan=100&idLessThan=200
Host: pi.pardot.com
Authorization: Bearer <access-token>
Example response:
HTTP/1.1200 OK
Content-Type: application/json
{"values":[{"id":101,"visitorId":344}]}
j