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.
| Operation | HTTP Verb | URL Format | Ability Requirements |
|---|---|---|---|
| Read | GET | https://pi.pardot.com/api/v5/objects/visitor-page-views/<id>?<params> | Prospect > Prospects > View ability |
| Query | GET | https://pi.pardot.com/api/v5/objects/visitor-page-views?<params> | Prospect > Prospects > View ability |
| Field | Type | Description |
|---|---|---|
id | Integer | ID of the object. |
url | String | Page view URL. |
title | String | Page title. |
visitorId | Integer | Account Engagement ID for the associated visitor. |
campaignId | Integer | Account Engagement ID for the associated campaign. |
visitId | Integer | Account Engagement ID for the associated visit. |
durationInSeconds | Integer | Length of this page view. |
salesforceId | String | Salesforce Id of the object. |
createdAt | DateTime | Creation time of this object. |
campaign | Campaign | Campaign object representing the campaign related to this object. See documentation for Campaign for fields. |
visit | Visit | Visit object representing the visit related to this object. See documentation for Visit for fields. |
Retrieve a single visitor page view following the conventions described in the Version 5 Overview.
Example request:
Example response:
Retrieving a collection of visitor page view 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.
idcreatedAtvisitorIdvisitId
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 visitor page view where ID is equal to the given integer value. |
idList | Returns any visitor page view where ID is included in the given list of values. |
idGreaterThan | Returns any visitor page view where ID is greater than the specified value, non-inclusive. |
idGreaterThanOrEqualTo | Returns any visitor page view where ID is greater than or equal to the specified value. |
idLessThan | Returns any visitor page view where ID is less than the specified value, non-inclusive. |
idLessThanOrEqualTo | Returns any visitor page view where ID is less than or equal to the specified value. |
visitorId | Returns any visitor page view where VisitorId is equal to the given integer value. |
visitorIdGreaterThan | Returns any visitor page view where VisitorId is greater than the specified value, non-inclusive. |
visitorIdGreaterThanOrEqualTo | Returns any visitor page view where VisitorId is greater than or equal to the specified value. |
visitorIdLessThan | Returns any visitor page view where VisitorId is less than the specified value, non-inclusive. |
visitorIdLessThanOrEqualTo | Returns any visitor page view where VisitorId is less than or equal to the specified value. |
visitId | Returns any visitor page view where VisitId is equal to the given integer value. |
visitIdGreaterThan | Returns any visitor page view where VisitId is greater than the specified value, non-inclusive. |
visitIdGreaterThanOrEqualTo | Returns any visitor page view where VisitId is greater than or equal to the specified value. |
visitIdLessThan | Returns any visitor page view where VisitId is less than the specified value, non-inclusive. |
visitIdLessThanOrEqualTo | Returns any visitor page view where VisitId is less than or equal to the specified value. |
createdAt | Returns any visitor page view where CreatedAt is equal to the given datetime value. |
createdAtAfter | Returns any visitor page view where CreatedAt is after the given datetime value, non-inclusive. |
createdAtAfterOrEqualTo | Returns any visitor page view where CreatedAt is after or equal to the given datetime value. |
createdAtBefore | Returns any visitor page view where CreatedAt is before the given datetime value, non-inclusive. |
createdAtBeforeOrEqualTo | Returns any visitor page view where CreatedAt is before or equal to the given datetime value. |
Example request:
Example response: