Visitor Page View Object

Use visitor page view resources to learn about page views on your website.

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

Supported Operations

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

Fields

Read-Only Fields

FieldTypeDescription
idIntegerID of the object.
urlStringPage view URL.
titleStringPage title.
visitorIdIntegerPardot ID for the associated visitor.
campaignIdIntegerPardot ID for the associated campaign.
visitIdIntegerPardot ID for the associated visit.
durationInSecondsIntegerLength of this page view.
salesforceIdStringSalesforce Id of the object.
createdAtDateTimeCreation time of this object.
campaignCampaignCampaign object representing the campaign related to this object. See documentation for Campaign for fields.
visitVisitVisit object representing the visit related to this object. See documentation for Visit for fields.

Visitor Page View Read

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

Example request:

Example response:

Visitor Page View Query

Retrieving a collection of visitor page view 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
  • createdAt

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 visitor page view where ID is equal to the given integer value.
idGreaterThanReturns any visitor page view where ID is greater than the specified value, non-inclusive.
idGreaterThanOrEqualToReturns any visitor page view where ID is greater than or equal to the specified value.
idLessThanReturns any visitor page view where ID is less than the specified value, non-inclusive.
idLessThanOrEqualToReturns any visitor page view where ID is less than or equal to the specified value.
visitorIdReturns any visitor page view where VisitorId is equal to the given integer value.
visitorIdGreaterThanReturns any visitor page view where VisitorId is greater than the specified value, non-inclusive.
visitorIdGreaterThanOrEqualToReturns any visitor page view where VisitorId is greater than or equal to the specified value.
visitorIdLessThanReturns any visitor page view where VisitorId is less than the specified value, non-inclusive.
visitorIdLessThanOrEqualToReturns any visitor page view where VisitorId is less than or equal to the specified value.
visitIdReturns any visitor page view where VisitId is equal to the given integer value.
visitIdGreaterThanReturns any visitor page view where VisitId is greater than the specified value, non-inclusive.
visitIdGreaterThanOrEqualToReturns any visitor page view where VisitId is greater than or equal to the specified value.
visitIdLessThanReturns any visitor page view where VisitId is less than the specified value, non-inclusive.
visitIdLessThanOrEqualToReturns any visitor page view where VisitId is less than or equal to the specified value.
createdAtReturns any visitor page view where CreatedAt is equal to the given datetime value.
createdAtAfterReturns any visitor page view where CreatedAt is after the given datetime value, non-inclusive.
createdAtAfterOrEqualToReturns any visitor page view where CreatedAt is after or equal to the given datetime value.
createdAtBeforeReturns any visitor page view where CreatedAt is before the given datetime value, non-inclusive.
createdAtBeforeOrEqualToReturns any visitor page view where CreatedAt is before or equal to the given datetime value.

Example request:

Example response: