Landing Page Object

A landing page is a web page that a visitor reaches after clicking a link or advertisement. This page generally displays content that is specific to the advertisement, search keyword, or link clicked. Landing page visitors can be more likely to convert when you present them with relevant, actionable content.

Learn more about landing pages in Salesforce Help.

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

OperationHTTP VerbURL FormatAbility Requirements
ReadGEThttps://pi.pardot.com/api/v5/objects/landing-pages/<id>?<params>Landing Pages > Landing Page > View ability
QueryGEThttps://pi.pardot.com/api/v5/objects/landing-pages?<params>Landing Pages > Landing Page > View ability
FieldTypeDescription
idIntegerID of the object.
nameStringName of the object for identification in Account Engagement.
salesforceIdStringSalesforce Id of the object.
isDeletedBooleanTrue if the object is in the recycle bin in Account Engagement.
createdByIdIntegerID of the user who created this object.
createdAtDateTimeCreation time of the object.
updatedAtDateTimeLast update time of the object.
updatedByIdIntegerID of the user who last updated this object.
campaignIdIntegerAccount Engagement Campaign related to this object.
formIdIntegerID of the form related to this object.
layoutTemplateIdIntegerID of the layout template related to this object.
titleStringThe landing page's title.
descriptionStringThe landing page's meta description. Used for SEO.
isDoNotIndexBooleanTrue if the landing page is hidden from search engine indexing.
layoutTypeEnumSpecifies where the landing page was created. Possible values are Layout Template, Landing Page Builder, Legacy Page Builder, Salesforce Builder.
scriptFragmentStringScript specified for the landing page. Available only on read requests.
layoutCssStringCSS code for the layout template. Available only on read requests.
layoutCssGeneratedStringGenerated CSS code for the layout template. Available only on read requests.
layoutTableBorderIntegerSpecifies the layout table border width.
redirectLocationStringThe redirect URL used if the prospect is redirected instead of showing the thank you content.
isUseRedirectLocationBooleanTrue if the prospect is redirected instead of showing the form thank you content.
bitlyIsPersonalizedBooleanTrue if the object has a bitly URL that is personalized.
bitlyShortUrlStringBitly URL if present.
urlStringLink for the landing page.
vanityUrlStringVanity URL if present.
vanityUrlPathStringThe unique path for the asset, used to create the vanity URL.
trackerDomainIdIntegerThe ID of the tracker domain associated with this object.
folderIdIntegerThe ID of the folder associated with this object.
layoutTemplateLayout TemplateLayout Template object representing the layout template associated with the landing page. See the documentation for Layout Template for fields.
formFormForm object representing the form associated with the landing page. See the documentation for Form for fields.
createdByUserUser object representing the user who created this object. See documentation for User for fields.
updatedByUserUser object representing the user who last updated this object. See documentation for User for fields.
trackerDomainTrackerDomainTracker Domain object representing the tracker domain that was set on Create. See documentation for Tracker Domain for fields. A null value indicates that the object uses the default tracker domain for the account.
campaignCampaignCampaign object representing the campaign that was set on Create. See documentation for Campaign for fields.
folderFolderJSON object representing the folder for this object. See documentation for Folder for fields.

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

Example request:

Example response:

Retrieving a collection of landing pages follows the conventions described in Version 5 Overview.

Example request:

Example response:

When executing a query, the following fields can be specified. See the conventions for query described in the Version 5 Overview.

  • id
  • createdAt
  • updatedAt

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 landing pages where ID is equal to the given integer value.
idListReturns any landing pages where ID is included in the given list of values.
idGreaterThanReturns any landing pages where ID is greater than the specified value, non-inclusive.
idGreaterThanOrEqualToReturns any landing pages where ID is greater than or equal to the specified value.
idLessThanReturns any landing pages where ID is less than the specified value, non-inclusive.
idLessThanOrEqualToReturns any landing pages where ID is less than or equal to the specified value.
nameReturns any landing pages where Name is equal to the given string value.
createdAtReturns any landing pages where CreatedAt is equal to the given datetime value.
createdAtAfterReturns any landing pages where CreatedAt is after the given datetime value, non-inclusive.
createdAtAfterOrEqualToReturns any landing pages where CreatedAt is after or equal to the given datetime value.
createdAtBeforeReturns any landing pages where CreatedAt is before the given datetime value, non-inclusive.
createdAtBeforeOrEqualToReturns any landing pages where CreatedAt is before or equal to the given datetime value.
updatedAtReturns any landing pages where UpdatedAt is equal to the given datetime value.
updatedAtAfterReturns any landing pages where UpdatedAt is after the given datetime value, non-inclusive.
updatedAtAfterOrEqualToReturns any landing pages where UpdatedAt is after or equal to the given datetime value.
updatedAtBeforeReturns any landing pages where UpdatedAt is before the given datetime value, non-inclusive.
updatedAtBeforeOrEqualToReturns any landing pages where UpdatedAt is before or equal to the given datetime value.
deletedDetermines whether to return deleted records. The value can be false (default), true, or all.

Example request:

Example response: