Visits

Use visit resources to learn about a user visit to your website. Discover the user's Pardot ID, Google Analytics parameters, and other information.

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

Supported Operations

OperationHTTP VerbURL FormatAbility Requirements
ReadGEThttps://pi.pardot.com/api/v5/objects/visits/<id>?<params>Prospect > Prospects > View ability
QueryGEThttps://pi.pardot.com/api/v5/objects/visits?<params>Prospect > Prospects > View ability

Fields

Read-Only Fields

FieldTypeDescription
idIntegerID of the object.
visitorIdIntegerPardot ID for the associated visitor.
prospectIdIntegerPardot ID for the associated prospect.
visitorPageViewCountIntegerNumber of page views for this visit.
firstVisitorPageViewAtDateTimeTime of first page view for this visit; Time is reported in API user's preferred timezone.
lastVisitorPageViewAtDateTimeTime of last page view for this visit; Time is reported in API user's preferred timezone.
durationInSecondsIntegerLength of this visit.
campaignParameterStringVisit's campaign parameter utm_campaign from Google Analytics.
mediumParameterStringVisit's medium parameter utm_medium from Google Analytics.
sourceParameterStringVisit's source parameter utm_source from Google Analytics.
contentParameterStringVisit's content parameter utm_content from Google Analytics.
termParameterStringVisit's term parameter utm_term from Google Analytics.
createdAtDateTimeCreation time of this object.
updatedAtDateTimeLast updated time for the object.
prospectProspectProspect 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:

Example response:

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:

Example response:

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.

ParameterDescription
idReturns any visit where ID is equal to the given integer value.
idGreaterThanReturns any visit where ID is greater than the specified value, non-inclusive.
idGreaterThanOrEqualToReturns any visit where ID is greater than or equal to the specified value.
idLessThanReturns any visit where ID is less than the specified value, non-inclusive.
idLessThanOrEqualToReturns any visit where ID is less than or equal to the specified value.
visitorIdReturns any visit where VisitorId is equal to the given integer value.
visitorIdGreaterThanReturns any visit where VisitorId is greater than the specified value, non-inclusive.
visitorIdGreaterThanOrEqualToReturns any visit where VisitorId is greater than or equal to the specified value.
visitorIdLessThanReturns any visit where VisitorId is less than the specified value, non-inclusive.
visitorIdLessThanOrEqualToReturns any visit where VisitorId is less than or equal to the specified value.
prospectIdReturns any visit where ProspectId is equal to the given integer value.
prospectIdGreaterThanReturns any visit where ProspectId is greater than the specified value, non-inclusive.
prospectIdGreaterThanOrEqualToReturns any visit where ProspectId is greater than or equal to the specified value.
prospectIdLessThanReturns any visit where ProspectId is less than the specified value, non-inclusive.
prospectIdLessThanOrEqualToReturns any visit where ProspectId is less than or equal to the specified value.
createdAtReturns any visit where CreatedAt is equal to the given datetime value.
createdAtAfterReturns any visit where CreatedAt is after the given datetime value, non-inclusive.
createdAtAfterOrEqualToReturns any visit where CreatedAt is after or equal to the given datetime value.
createdAtBeforeReturns any visit where CreatedAt is before the given datetime value, non-inclusive.
createdAtBeforeOrEqualToReturns any visit where CreatedAt is before or equal to the given datetime value.
updatedAtReturns any visit where UpdatedAt is equal to the given datetime value.
updatedAtAfterReturns any visit where UpdatedAt is after the given datetime value, non-inclusive.
updatedAtAfterOrEqualToReturns any visit where UpdatedAt is after or equal to the given datetime value.
updatedAtBeforeReturns any visit where UpdatedAt is before the given datetime value, non-inclusive.
updatedAtBeforeOrEqualToReturns any visit where UpdatedAt is before or equal to the given datetime value.

Example request:

Example response: