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.
| Operation | HTTP Verb | URL Format | Ability Requirements |
|---|---|---|---|
| Read | GET | https://pi.pardot.com/api/v5/objects/landing-pages/<id>?<params> | Landing Pages > Landing Page > View ability |
| Query | GET | https://pi.pardot.com/api/v5/objects/landing-pages?<params> | Landing Pages > Landing Page > View ability |
| Field | Type | Description |
|---|---|---|
id | Int | ID of the object. |
name | String | Name of the object for identification in Account Engagement. |
salesforceId | String | Salesforce Id of the object. |
isDeleted | Boolean | True if the object is in the recycle bin in Account Engagement. |
createdById | Int | ID of the user who created this object. |
createdAt | DateTime | Creation time of the object. |
updatedAt | DateTime | Last update time of the object. |
updatedById | Int | ID of the user who last updated this object. |
campaignId | Int | Account Engagement Campaign related to this object. |
formId | Int | ID of the form related to this object. |
layoutTemplateId | Int | ID of the layout template related to this object. |
title | String | The landing page's title. |
description | String | The landing page's meta description. Used for SEO. |
isDoNotIndex | Boolean | True if the landing page is hidden from search engine indexing. |
layoutType | Enum | Specifies where the landing page was created. Possible values are Layout Template, Landing Page Builder, Legacy Page Builder, Salesforce Builder. |
scriptFragment | String | Script specified for the landing page. Available only on read requests. |
layoutCss | String | CSS code for the layout template. Available only on read requests. |
layoutCssGenerated | String | Generated CSS code for the layout template. Available only on read requests. |
layoutTableBorder | Int | Specifies the layout table border width. |
redirectLocation | String | The redirect URL used if the prospect is redirected instead of showing the thank you content. |
isUseRedirectLocation | Boolean | True if the prospect is redirected instead of showing the form thank you content. |
bitlyIsPersonalized | Boolean | True if the object has a bitly URL that is personalized. |
bitlyShortUrl | String | Bitly URL if present. |
url | String | Link for the landing page. |
vanityUrl | String | Vanity URL if present. |
vanityUrlPath | String | The unique path for the asset, used to create the vanity URL. |
trackerDomainId | Int | The ID of the tracker domain associated with this object. |
folderId | Int | The ID of the folder associated with this object. |
layoutTemplate | Layout Template | Layout Template object representing the layout template associated with the landing page. See the documentation for Layout Template for fields. |
form | Form | Form object representing the form associated with the landing page. See the documentation for Form for fields. |
createdBy | User | User object representing the user who created this object. See documentation for User for fields. |
updatedBy | User | User object representing the user who last updated this object. See documentation for User for fields. |
trackerDomain | TrackerDomain | Tracker 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. |
campaign | Campaign | Campaign object representing the campaign that was set on Create. See documentation for Campaign for fields. |
folder | Folder | JSON 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.
idcreatedAtupdatedAt
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 landing pages where ID is equal to the given integer value. |
idList | Returns any landing pages where ID is included in the given list of values. |
idGreaterThan | Returns any landing pages where ID is greater than the specified value, non-inclusive. |
idGreaterThanOrEqualTo | Returns any landing pages where ID is greater than or equal to the specified value. |
idLessThan | Returns any landing pages where ID is less than the specified value, non-inclusive. |
idLessThanOrEqualTo | Returns any landing pages where ID is less than or equal to the specified value. |
name | Returns any landing pages where Name is equal to the given string value. |
createdAt | Returns any landing pages where CreatedAt is equal to the given datetime value. |
createdAtAfter | Returns any landing pages where CreatedAt is after the given datetime value, non-inclusive. |
createdAtAfterOrEqualTo | Returns any landing pages where CreatedAt is after or equal to the given datetime value. |
createdAtBefore | Returns any landing pages where CreatedAt is before the given datetime value, non-inclusive. |
createdAtBeforeOrEqualTo | Returns any landing pages where CreatedAt is before or equal to the given datetime value. |
updatedAt | Returns any landing pages where UpdatedAt is equal to the given datetime value. |
updatedAtAfter | Returns any landing pages where UpdatedAt is after the given datetime value, non-inclusive. |
updatedAtAfterOrEqualTo | Returns any landing pages where UpdatedAt is after or equal to the given datetime value. |
updatedAtBefore | Returns any landing pages where UpdatedAt is before the given datetime value, non-inclusive. |
updatedAtBeforeOrEqualTo | Returns any landing pages where UpdatedAt is before or equal to the given datetime value. |
deleted | Determines whether to return deleted records. The value can be false (default), true, or all. |
Example request:
Example response: