A landing page is a web page that a visitor reaches after clicking a link or advertisement. This page generally displays content that’s 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.
Name of the object for identification in Account Engagement.
campaignId
Integer
ID of the campaign related to this object.
Optional Editable Fields
Field
Type
Description
folderId
Integer
ID of the folder containing this object.
formId
Integer
ID of the form related to this object.
layoutTemplateId
Integer
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.
vanityUrlPath
String
The unique path for the asset, used to create the vanity URL.
scriptFragment
String
The script specified for a landing page using a stock template. This field isn’t queryable.
redirectLocation
String
The redirect URL used if the prospect is redirected instead of showing the thank you content.
trackerDomainId
Integer
ID of the tracker domain associated with this object.
archiveDate
Date
The landing page’s archive date(‘yyyy-mm-dd’).
content
String
The editable content if using a stock template. This field isn’t queryable.
openingGeneralContent
String
If using a layout template without pardot-region attributes, this value is displayed in the %%form-opening-general-content%% tag. More info. This field isn’t queryable.
regionContent
String
If using a layout template that contains pardot-region attributes, the values here override the default values in the layout template. For default values in the layout template, see Layout Template. This field isn’t queryable.
Read-Only Fields
Field
Type
Description
id
Integer
ID of the object.
salesforceId
String
Salesforce Id of the object.
isDeleted
Boolean
True if the object is in the recycle bin in Account Engagement.
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.
The value for regionContent is a comma-separated enumeration of the regions. It follows this format, where regionName is the value of the pardot-region attribute to the HTML element defined in the layout template.
The layoutTemplateId field is required and the regionContent field is optional.
Example request:
1POST /api/v5/objects/landing-pages?fields=id,name,campaignId,formId,layoutTemplateId,layoutType,title,regionContent,trackerDomainId,vanityUrl,archiveDate HTTP/1.12Host: pi.pardot.com.rproxy.goskope.com3Authorization: Bearer <access-token>4Content-Type: application/json56{7 "name": "my template with region",8 "campaignId": 1,9 "formId": 1,10 "layoutTemplateId": 7,11 "title": "Webinar Registration",12 "regionContent": {13 "imageRegionName": {14 "alt": "Lenoxsoft Dashboard",15 "height": "300",16 "width": "200",17 "src": "https://www.lenoxsoft.com/wp-content/uploads/2014/12/lenoxsoft-dashboard.png"18},19 "linkRegionName": {20 "href": "https://www.lenoxsoft.com",21 "target": "_blank"22},23 "simpleRegionName": {24 "content": "LenoxSoft has everything you need to easily automate invoicing and quickly collect payments."25}26},27 "archiveDate": "2024-11-01"28}
Example response:
This example doesn’t show all the headers. Whitespace has been added to make it easier to read.
1HTTP/1.1 201 Created2Content-Type: application/json3https://pi.pardot.com/api/v5/objects/landing-pages/71?fields=id,name,campaignId,formId,layoutTemplateId,layoutType,title,regionContent,trackerDomainId,vanityUrl,archiveDate45{6 "id": 71,7 "archiveDate": "2024-11-01",8 "campaignId": 1,9 "formId": 1,10 "layoutTemplateId": 7,11 "layoutType": "layout template",12 "name": "my template with region",13 "regionContent": {14 "imageRegionName": {15 "alt": "Lenoxsoft Dashboard",16 "height": "300",17 "src": "https://www.lenoxsoft.com/wp-content/uploads/2014/12/lenoxsoft-dashboard.png",18 "width": "200"19},20 "linkRegionName": {21 "href": "https://www.lenoxsoft.com",22 "target": "_blank"23},24 "simpleRegionName": {25 "content": "LenoxSoft has everything you need to easily automate invoicing and quickly collect payments."26}27},28 "title": "Webinar Registration",29 "trackerDomainId": null,30 "vanityUrl": null31}
Examples include extra spaces for readability and don’t always include headers. The fields in the response body and Location header match the fields specified on the example request.
Landing Page Read
Retrieve a single landing page following the conventions described in the Version 5 Overview.
When executing a query, these fields can be specified. See the conventions for query described in the Version 5 Overview.
id
createdAt
updatedAt
Filtering Results
When executing a query, these parameters are used to filter the returned results. These parameters are 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 the 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 the 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.
layoutType
Returns any landing pages where LayoutType is equal to the given string value.
deleted
Determines whether to return deleted records. The value can be false (default), true, or all.
j