Managing Landing Pages

📘
API Docs
Detailed technical documentation is available here - Landing Page API Documentation

Using API to Get All Landing Pages

Overview
Hawksearch offers the following API’s to retrieve landing page information:

GET All Landing pages
This API allows you to retrieve all Landing Pages created in the Hawksearch dashboard.

Example use case: Get all landing pages of a site.

Request: GET request to the API below:

Response: The response is a JSON array of landing pages list, where each landing page is an array of string objects, every object being a series of key-value pairs. The description of the data is as follows:

[
    {
        "PageId": 11626742,
        "SyncGuid": "a0eaf05d-38ff-4b88-864c-17a0c12a759e",
        "Name": "Footwear",
        "CustomUrl": "/footwear/",
        "NarrowXml": "<?xml version=\"1.0\" encoding=\"utf-16\"?>\r\n<Rule xmlns:xsd=\"http://www.w3.org/2001/XMLSchema\" xmlns:xsi=\"http://www.w3.org/2001/XMLSchema-instance\" RuleType=\"Group\" HasFacetCoverage=\"false\" Operator=\"Any\">\r\n  <Rules>\r\n    <Rule RuleType=\"Eval\" HasFacetCoverage=\"false\" Operator=\"None\">\r\n      <Rules />\r\n      <Field>keyword:Keyword</Field>\r\n      <Condition>contains</Condition>\r\n      <Value>sandals</Value>\r\n    </Rule>\r\n    <Rule RuleType=\"Eval\" HasFacetCoverage=\"false\" Operator=\"None\">\r\n      <Rules />\r\n      <Field>keyword:Keyword</Field>\r\n      <Condition>contains</Condition>\r\n      <Value>shoe</Value>\r\n    </Rule>\r\n  </Rules>\r\n  <Field />\r\n  <Condition />\r\n  <Value />\r\n</Rule>",
        "IsFacetOverride": true,
        "IsIncludeProducts": false,
        "SortFieldId": 0,
        "SortDirection": "Asc",
        "SelectedFacets": [
            {
                "FacetId": 17077,
                "Field": "color-property",
                "Label": "Color",
                "SortOrder": 1,
                "SortBy": null
            },
            {
                "FacetId": 17078,
                "Field": "size-property",
                "Label": "Size",
                "SortOrder": 2,
                "SortBy": null
            },
            {
                "FacetId": 17076,
                "Field": "saleprice",
                "Label": "Price",
                "SortOrder": 3,
                "SortBy": null
            }
        ],
        "PageLayoutId": null,
        "EnableFacetAutoOrdering": false,
        "Custom": null,
        "Tags": "promo,footwear",
        "CanonicalUrl": null,
        "PageType": "ProductListing",
        "ContentConfigList": [],
        "PageHeading": null,
        "CustomHtml": null,
        "Keywords": null,
        "ListName": null,
        "Notes": null,
        "CreateDate": "07-11-2013",
        "ModifyDate": "04-28-2016",
        "IsNoIndex": false,
        "IsNoFollow": false
    },
    {
        "PageId": 11620772,
        "SyncGuid": "39b30b49-d734-4f72-9af2-3d04e0a3c218",
        "Name": "July Fourth clone",
        "CustomUrl": "/4July232131/",
        "NarrowXml": "<?xml version=\"1.0\" encoding=\"utf-16\"?>\r\n<Rule xmlns:xsd=\"http://www.w3.org/2001/XMLSchema\" xmlns:xsi=\"http://www.w3.org/2001/XMLSchema-instance\" RuleType=\"Group\" HasFacetCoverage=\"false\" Operator=\"Any\">\r\n  <Rules>\r\n    <Rule RuleType=\"Eval\" HasFacetCoverage=\"false\" Operator=\"None\">\r\n      <Rules />\r\n      <Field>facet:color-property</Field>\r\n      <Condition>is not</Condition>\r\n      <Value>Brown</Value>\r\n    </Rule>\r\n  </Rules>\r\n  <Field />\r\n  <Condition />\r\n  <Value />\r\n</Rule>",
        "IsFacetOverride": true,
        "IsIncludeProducts": false,
        "SortFieldId": 0,
        "SortDirection": "Asc",
        "SelectedFacets": [
            {
                "FacetId": 17080,
                "Field": "brand",
                "Label": "Brand",
                "SortOrder": 1,
                "SortBy": null
            },
            {
                "FacetId": 17089,
                "Field": "department_nest",
                "Label": "Department",
                "SortOrder": 2,
                "SortBy": null
            },
            {
                "FacetId": 17077,
                "Field": "color-property",
                "Label": "Color",
                "SortOrder": 3,
                "SortBy": null
            },
            {
                "FacetId": 17081,
                "Field": "type",
                "Label": "Type",
                "SortOrder": 4,
                "SortBy": null
            },
            {
                "FacetId": 17076,
                "Field": "saleprice",
                "Label": "Price",
                "SortOrder": 5,
                "SortBy": null
            }
        ]
            }
]

No	Key	Description	Value Type
1	PageId	The unique identifier of the landing page(unique across the whole system)	Number
2	SyncGuid	Internal field	GUID
3	Name	This field allows you to provide a unique SEO Title for your landing page.	lowercase alphanumeric string with underscores allowed
4	CustomUrl	The url of the landing page	Alphanumeric string
5	NarrowXml	The conditional rule used to pull up the landing page.	XML
6	IsFacetOverride	Flag to control if facets are getting overrideen on this landing pahe	Boolean
7	SortFieldId	The FieldId of the sorting option used to sort items on the page. This comes from the Sorting/Pagination section under Workebench >>Data Configuration	Number
8	SortDirection	If the sortfield above is to be sorted in ascending or descending order	AscDesc
9	SelectedFacets	This is an array of facet objects where each object is a key-value pair. Below example what each object should {"FacetId": 17082,"Field": "sectioncategory","Label": "Section","SortOrder": 1,"SortBy": "ScoreAndAlphaAndAlpha"}	FacetId = Id of the facetField = Name of the facetLabel = Display value of the facetSort Order = The order in which the facet will be displayed on the pageSortBy = Sorting option for the items on the page
10	PageLayoutId	For Content pages, this is the id of the pagelayout	Number
11	EnableFacetAutoOrdering	If you want the facets to be ordered automatically	Boolean
12	Custom	You can utilize the Custom Field for unique codes or notes that you don't want to be overwritten by anyone else on the team.	Alphanumeric string
13	Tags	Tags can be utilized by business users to quickly locate merchandising elements relating to themes or strategies.	Alphanumeric string
14	CanonicalUrl	The canonical URL is single URL that a search engine will use to identify the page. It consolidates the information for individual on a single preferred URL.	Alphanumeric string
15	PageType	The type of the page. There are only 2 types available:ContentProductListing	String
16	ContentConfigList	Configuration for Content items	Alphanumeric string
17	PageHeading	This field allows you to provide a unique name. Choose a name that you can easily associate with this page.	Alphanumeric string
18	CustomHtml	HTML used for content data	Alphanumeric string
19	Keywords		Alphanumeric string
20	ListName		Alphanumeric string
21	Notes	This can be used to add notes or information unique to this page	Alphanumeric string
22	CreateDate	Field creation date	Date string in MM-DD-YYYY format
23	ModifyDate	Field modification date	Date string in MM-DD-YYYY format
24	IsNoIndex	noindex means that a web page shouldn't be indexed by search engines and therefore shouldn't be shown on the search engine's result pages.	Boolean
25	IsNoFollow	nofollow means that search engines spiders shouldn't follow the links on that page.	Boolean
26	MetaDescription	Meta Description is used to describe your landing page.	Alphanumeric string
27	MetaKeywords	Meta Keywords are short concise phrases or terms that best describe your landing page. This is unique for each landing page.It is important to put the most important words or phrases at the beginning of the list. Separate the words or phrases by commas, however spaces are not needed between commas and new words.	Alphanumeric string

Using API to Get a Landing Page

Overview
This API allows you to retrieve a single landing page in Hawksearch dashboard.

Request

Get Landing Page API Documentation

Response
The response is an array of landing page objects, every object being a series of key-value pairs.

GET Methods

GET api/v11/LandingPage/{id}

Returns Landing Page with a particular Id.
Parameters
- id: Unique Id of the Landing Page (FromUri)
- version: (FromUri)

GET api/v11/LandingPage/{guid}

Returns Landing Page with a particular Id.
Parameters
- guid: Unique Id of the Landing Page (FromUri)
- version: (FromUri)

GET api/v11/LandingPage/urls

Retrieves list of all available Landing Page URLs
Parameters
- version: (FromUri)

GET api/v11/LandingPage/Custom

Retrieves all values of the Custom field in pages
Parameters
- version: (FromUri)

GET api/v11/LandingPage/url/{url}

Returns Landing Page with a particular custom url
Parameters
- url: Custom url of the Landing Page (FromUri)
- version: (FromUri)

GET api/v11/LandingPage/custom/{custom}

Get Landing Page entity by Custom field
Parameters
- custom: Custom field value (FromUri)
- version: (FromUri)

Using API to Create Landing Pages

Overview
This API allows you to create a landing page in Hawksearch dashboard.

Product Listing Landing Page

Request: POST request to the API below:

Create Landing Page API Documentation

{
    "Name": "Columbia Sportswear®",
    "Title": "Columbia Sportswear Title 2",
    "MetaDescription": "Columbia Landing Page Meta Description",
    "MetaKeywords": "columbia landing page meta keywords",
    "CustomUrl": "/brands/columbia/",
    "Breadcrumb": "<p><a href=\"http://www.erehwon.com/\" target=\"_blank\">Home</a>&nbsp;&gt;&nbsp;<a href=\"http://www.erehwon.com/store/brands/\" target=\"_blank\">View All Brands</a>&nbsp;&gt;&nbsp;Columbia <strong>Sportswear</strong></p>",
    "NarrowXml": "<?xml version=\"1.0\" encoding=\"utf-16\"?>\r\n<Rule xmlns:xsd=\"http://www.w3.org/2001/XMLSchema\" xmlns:xsi=\"http://www.w3.org/2001/XMLSchema-instance\" Operator=\"All\" RuleType=\"Group\">\r\n  <Rules>\r\n    <Rule Operator=\"None\" RuleType=\"Eval\">\r\n      <Rules />\r\n      <Field>facet:brand</Field>\r\n      <Condition>contains</Condition>\r\n      <Value>Columbia Sportswear</Value>\r\n    </Rule>\r\n  </Rules>\r\n  <Field />\r\n  <Condition />\r\n  <Value />\r\n</Rule>",
    "IsFacetOverride": true,
    "IsIncludeProducts": false,
    "SortFieldId": 0,
    "SortDirection": "Asc",
    "SelectedFacets": [
        {
            "FacetId": 114,
            "Field": "",
            "Label": "Search within these results",
            "SortOrder": 1,
            "SortBy": null
        },
        {
            "FacetId": 12114,
            "Field": "department_nest",
            "Label": "Department",
            "SortOrder": 2,
            "SortBy": ""
        },
        {
            "FacetId": 99,
            "Field": "size-property",
            "Label": "Size",
            "SortOrder": 3,
            "SortBy": "Score"
        },
        {
            "FacetId": 98,
            "Field": "color-property",
            "Label": "Color",
            "SortOrder": 4,
            "SortBy": ""
        }
    ],
    "PageLayoutId": null,
    "EnableFacetAutoOrdering": false,
    "Custom": "",
    "Tags": "brand,promo,columbia",
    "CanonicalUrl": "",
    "PageType": "ProductListing",
    "ContentConfigList": [],
    "PageHeading": "",
    "CustomHtml": "",
    "Keywords": null,
    "ListName": "Columbia Sportswear®",
    "Notes": "lorem ipsum dolor",
    "IsNoIndex": false,
    "IsNoFollow": false,
    "StartDate": "01-01-0001",
    "EndDate": "01-01-0001"
}

Content Landing Page
Request: POST request to the API below:

{
    "Name": "Content LP",
    "Title": "Content LP",
    "MetaDescription": "",
    "MetaKeywords": "",
    "CustomUrl": "contentlp",
    "Breadcrumb": "",
    "NarrowXml": "<?xml version=\"1.0\" encoding=\"utf-16\"?>\r\n<Rule xmlns:xsd=\"http://www.w3.org/2001/XMLSchema\" xmlns:xsi=\"http://www.w3.org/2001/XMLSchema-instance\" Operator=\"All\" RuleType=\"Group\">\r\n  <Rules />\r\n  <Field />\r\n  <Condition />\r\n  <Value />\r\n</Rule>",
    "IsFacetOverride": false,
    "IsIncludeProducts": false,
    "SortFieldId": 0,
    "SortDirection": null,
    "SelectedFacets": [],
    "PageLayoutId": 326,
    "EnableFacetAutoOrdering": false,
    "Custom": "",
    "Tags": "",
    "CanonicalUrl": "",
    "PageType": "Content",
    "ContentConfigList": [
        {
            "ZoneName": "Header",
            "ZoneConfig": [
                {
                    "BannerId": 103550,
                    "CustomValue": null,
                    "DateFrom": "01-01-0001",
                    "DateTo": "01-01-0001",
                    "SortOrder": 0,
                    "TriggerXml": "<?xml version=\"1.0\" encoding=\"utf-16\"?>\r\n<Rule xmlns:xsd=\"http://www.w3.org/2001/XMLSchema\" xmlns:xsi=\"http://www.w3.org/2001/XMLSchema-instance\" Operator=\"Any\" RuleType=\"Group\">\r\n  <Rules />\r\n  <Field />\r\n  <Condition />\r\n  <Value />\r\n</Rule>"
                }
            ]
        },
        {
            "ZoneName": "Sub Content 1",
            "ZoneConfig": [
                {
                    "BannerId": 73532,
                    "CustomValue": null,
                    "DateFrom": "01-01-0001",
                    "DateTo": "01-01-0001",
                    "SortOrder": 0,
                    "TriggerXml": "<?xml version=\"1.0\" encoding=\"utf-16\"?>\r\n<Rule xmlns:xsd=\"http://www.w3.org/2001/XMLSchema\" xmlns:xsi=\"http://www.w3.org/2001/XMLSchema-instance\" Operator=\"Any\" RuleType=\"Group\">\r\n  <Rules />\r\n  <Field />\r\n  <Condition />\r\n  <Value />\r\n</Rule>"
                }
            ]
        },
        {
            "ZoneName": "Other",
            "ZoneConfig": []
        },
        {
            "ZoneName": "Bottom content",
            "ZoneConfig": [
                {
                    "BannerId": 73532,
                    "CustomValue": null,
                    "DateFrom": "01-01-0001",
                    "DateTo": "01-01-0001",
                    "SortOrder": 0,
                    "TriggerXml": "<?xml version=\"1.0\" encoding=\"utf-16\"?>\r\n<Rule xmlns:xsd=\"http://www.w3.org/2001/XMLSchema\" xmlns:xsi=\"http://www.w3.org/2001/XMLSchema-instance\" Operator=\"Any\" RuleType=\"Group\">\r\n  <Rules />\r\n  <Field />\r\n  <Condition />\r\n  <Value />\r\n</Rule>"
                }
            ]
        }
    ],
    "PageHeading": "Content LP",
    "CustomHtml": "test example used in automation testing",
    "Keywords": null,
    "ListName": null,
    "Notes": "",
    "IsNoIndex": false,
    "IsNoFollow": false,
    "StartDate": "01-01-0001",
    "EndDate": "01-01-0001"
}

Response
The response is an array of landing page objects, every object being a series of key-value pairs. Description of the data is as follows:

Key	Description	Value Type
PageId	The unique identifier of the landing page (unique across the whole system)	Number
SyncGuid	Internal field	GUID
Name	The Name Field allows you to provide a unique name. Choose a name that you can easily associate with this element.	String
ListName	List Name is what will appear in the list of Landing Pages for future reference on the Administration Page.	String
Title	Display title of the landing page	String
MetaDescription	SEO property. The Meta Description should be a short concise summary of your website. This description is usually shown in conjunction with your Page Title in search engine results	String
MetaKeywords	SEO property. Meta Keywords are short concise phrases or terms that best describe your website. It is important to put the most important words or phrases at the beginning of the list. Separate the words or phrases by commas, however spaces are not needed between commas and new words.	String
CustomUrl	The Custom URL field allows you to design the URL requested from Hawk Search for this landing page. Please keep in mind that Hawk Search does not perform any URL re-writing so this is merely the URL requested from Hawk Search - NOT the URL customers would type into an address bar to reach this page.	String
Breadcrumb	The Breadcrumb field allows you to manually list out any navigational states you'd like to include in your Landing Page. A common example is to provide a link back to the home page, then any category or sub category.	String, HTML
NarrowXml	A rule to narrow down the landing pages products. Used on Product listing landing pages	String
IsFacetOverride	Overriding the Default Facets allows you control what left hand navigation options are presented on your landing pages. This way, you can simplify the facets so that only the most appropriate choices are available to customers on your custom landing page.	Boolean
IsIncludeProducts	Are there any products included?	Boolean
SortFieldId	Custom sorting field	String
SortDirection	Custom sorting direction	String
SelectedFacets	List of facets selected on a landing page	SelectedFacets array of objects
PageLayoutId	A content layout configuration	Number
EnableFacetAutoOrdering	A default setting for suggester facet sorting	Boolean
Custom	You can utilize the Custom Field for unique codes or notes that you don't want to be overwritten by anyone else on the team. This field can be set as Read Only through the Administrative Settings to prevent it from being modified.	String
Tags	Engine-wide labels (avilable acros complete dashboard)	Comma separated alphanumeric string
CanonicalUrl	SEO configuration. The canonical URL is single URL that a search engine will use to identify the page. It consolidates the information for individual on a single preferred URL	String
PageType	Product listing or content	String
ContentConfigList	Landing page custom config for zones	Object
PageHeading	Additional page heading	String
CustomHtml	Additional page html	String
Keywords	Custom keywords	String
Notes	Custom notes	String
CreateDate	Creation date	Date string in MM-DD-YYYY format
ModifyDate	Modification date	Date string in MM-DD-YYYY format
IsNoIndex	SEO property	Boolean
IsNoFollow	SEO property	Boolean
StartDate	Start date for landing page to be active	Date string in MM-DD-YYYY format
EndDate	End date for landing page to be active	Date string in MM-DD-YYYY format

POST Methods

POST api/v1/LandingPage

Add new Landing Page.
Parameters
- value: Landing Page object (FromBody)
- version: (FromUri)

POST api/v11/LandingPage/bulk

Add multiple Landing Pages at once

Parameters

pages: Collection of Landing Page objects (FromBody)

version: (FromUri)

Using API to Update Landing Pages

Overview
This API allows you to update a landing page in Hawksearch dashboard.

Product Listing Landing Page
Request: PUT request to the API below

Update Landing Page API Documentation

{
    "PageId": 1234,
    "Name": "Columbia Sportswear®",
    "Title": "Columbia Sportswear Title 2",
    "MetaDescription": "Columbia Landing Page Meta Description",
    "MetaKeywords": "columbia landing page meta keywords",
    "CustomUrl": "/brands/columbia/",
    "Breadcrumb": "<p><a href=\"http://www.erehwon.com/\" target=\"_blank\">Home</a>&nbsp;&gt;&nbsp;<a href=\"http://www.erehwon.com/store/brands/\" target=\"_blank\">View All Brands</a>&nbsp;&gt;&nbsp;Columbia <strong>Sportswear</strong></p>",
    "NarrowXml": "<?xml version=\"1.0\" encoding=\"utf-16\"?>\r\n<Rule xmlns:xsd=\"http://www.w3.org/2001/XMLSchema\" xmlns:xsi=\"http://www.w3.org/2001/XMLSchema-instance\" Operator=\"All\" RuleType=\"Group\">\r\n  <Rules>\r\n    <Rule Operator=\"None\" RuleType=\"Eval\">\r\n      <Rules />\r\n      <Field>facet:brand</Field>\r\n      <Condition>contains</Condition>\r\n      <Value>Columbia Sportswear</Value>\r\n    </Rule>\r\n  </Rules>\r\n  <Field />\r\n  <Condition />\r\n  <Value />\r\n</Rule>",
    "IsFacetOverride": true,
    "IsIncludeProducts": false,
    "SortFieldId": 0,
    "SortDirection": "Asc",
    "SelectedFacets": [
        {
            "FacetId": 114,
            "Field": "",
            "Label": "Search within these results",
            "SortOrder": 1,
            "SortBy": null
        },
        {
            "FacetId": 12114,
            "Field": "department_nest",
            "Label": "Department",
            "SortOrder": 2,
            "SortBy": ""
        },
        {
            "FacetId": 99,
            "Field": "size-property",
            "Label": "Size",
            "SortOrder": 3,
            "SortBy": "Score"
        },
        {
            "FacetId": 98,
            "Field": "color-property",
            "Label": "Color",
            "SortOrder": 4,
            "SortBy": ""
        }
    ],
    "PageLayoutId": null,
    "EnableFacetAutoOrdering": false,
    "Custom": "",
    "Tags": "brand,promo,columbia",
    "CanonicalUrl": "",
    "PageType": "ProductListing",
    "ContentConfigList": [],
    "PageHeading": "",
    "CustomHtml": "",
    "Keywords": null,
    "ListName": "Columbia Sportswear®",
    "Notes": "lorem ipsum dolor",
    "IsNoIndex": false,
    "IsNoFollow": false,
    "StartDate": "01-01-0001",
    "EndDate": "01-01-0001"
}

Content Landing Page
Request: POST request to the API below:

{
    "Name": "Content LP",
    "Title": "Content LP",
    "MetaDescription": "",
    "MetaKeywords": "",
    "CustomUrl": "contentlp",
    "Breadcrumb": "",
    "NarrowXml": "<?xml version=\"1.0\" encoding=\"utf-16\"?>\r\n<Rule xmlns:xsd=\"http://www.w3.org/2001/XMLSchema\" xmlns:xsi=\"http://www.w3.org/2001/XMLSchema-instance\" Operator=\"All\" RuleType=\"Group\">\r\n  <Rules />\r\n  <Field />\r\n  <Condition />\r\n  <Value />\r\n</Rule>",
    "IsFacetOverride": false,
    "IsIncludeProducts": false,
    "SortFieldId": 0,
    "SortDirection": null,
    "SelectedFacets": [],
    "PageLayoutId": 326,
    "EnableFacetAutoOrdering": false,
    "Custom": "",
    "Tags": "",
    "CanonicalUrl": "",
    "PageType": "Content",
    "ContentConfigList": [
        {
            "ZoneName": "Header",
            "ZoneConfig": [
                {
                    "BannerId": 103550,
                    "CustomValue": null,
                    "DateFrom": "01-01-0001",
                    "DateTo": "01-01-0001",
                    "SortOrder": 0,
                    "TriggerXml": "<?xml version=\"1.0\" encoding=\"utf-16\"?>\r\n<Rule xmlns:xsd=\"http://www.w3.org/2001/XMLSchema\" xmlns:xsi=\"http://www.w3.org/2001/XMLSchema-instance\" Operator=\"Any\" RuleType=\"Group\">\r\n  <Rules />\r\n  <Field />\r\n  <Condition />\r\n  <Value />\r\n</Rule>"
                }
            ]
        },
        {
            "ZoneName": "Sub Content 1",
            "ZoneConfig": [
                {
                    "BannerId": 73532,
                    "CustomValue": null,
                    "DateFrom": "01-01-0001",
                    "DateTo": "01-01-0001",
                    "SortOrder": 0,
                    "TriggerXml": "<?xml version=\"1.0\" encoding=\"utf-16\"?>\r\n<Rule xmlns:xsd=\"http://www.w3.org/2001/XMLSchema\" xmlns:xsi=\"http://www.w3.org/2001/XMLSchema-instance\" Operator=\"Any\" RuleType=\"Group\">\r\n  <Rules />\r\n  <Field />\r\n  <Condition />\r\n  <Value />\r\n</Rule>"
                }
            ]
        },
        {
            "ZoneName": "Other",
            "ZoneConfig": []
        },
        {
            "ZoneName": "Bottom content",
            "ZoneConfig": [
                {
                    "BannerId": 73532,
                    "CustomValue": null,
                    "DateFrom": "01-01-0001",
                    "DateTo": "01-01-0001",
                    "SortOrder": 0,
                    "TriggerXml": "<?xml version=\"1.0\" encoding=\"utf-16\"?>\r\n<Rule xmlns:xsd=\"http://www.w3.org/2001/XMLSchema\" xmlns:xsi=\"http://www.w3.org/2001/XMLSchema-instance\" Operator=\"Any\" RuleType=\"Group\">\r\n  <Rules />\r\n  <Field />\r\n  <Condition />\r\n  <Value />\r\n</Rule>"
                }
            ]
        }
    ],
    "PageHeading": "Content LP",
    "CustomHtml": "test example used in automation testing",
    "Keywords": null,
    "ListName": null,
    "Notes": "",
    "IsNoIndex": false,
    "IsNoFollow": false,
    "StartDate": "01-01-0001",
    "EndDate": "01-01-0001"
}

Response
The response is an array of landing page objects, every object being a series of key-value pairs. For the description of the data, please refer to Using API to Create Landing Pages

PUT Methods

PUT api/v11/LandingPage/{id}

Update Landing Page with a particular Id.
Parameters
- id: Unique Id of the Landing Page (FromUri)
- value: Landing Page object (FromBody)
- version: (FromUri)

PUT api/v11/LandingPage/{guid}

Update Landing Page with a particular Guid.
Parameters
- guid: Guid of the Landing Page (FromUri)
- value: Landing Page object (FromBody)
- version: (FromUri)

PUT api/v11/LandingPage/url/{url}

Update Landing Page with a particular Url.
Parameters
- url: Unique Url of the Landing Page (FromUri)
- value: Landing Page object (FromBody)
- version: (FromUri)

PUT api/v11/LandingPage/bulk

Update multiple Landing Pages at once.
Parameters
- pages: Collection of Landing Page objects to be updated (FromBody)
- version: (FromUri)

PUT api/v11/LandingPage/custom/{custom}

Update Landing Page by Custom field value
Parameters
- custom: No Documentation Found. (FromUri)
- value: No Documentation Found. (FromBody)
- version: (FromUri)

Using API to Delete a Landing Page

Overview
This API allows you to delete a landing page in Hawksearch dashboard.

Request

Delete Landing Page API Documentation

Response
The response is an array of landing page objects, every object being a series of key-value pairs. For the description of the data, please refer to Using API to Create Landing Pages

DELETE Methods

DELETE api/v11/LandingPage/{id}

Delete Landing Page with a particular Id.
Parameters
- id: Unique Id of the Landing Page (FromUri)
- version: (FromUri)

DELETE /api/v11/LandingPage/{guid}

Delete Landing Page with a particular Guid.
Parameters
- guid: Guid of the Landing Page (FromUri)
- version: (FromUri)

DELETE api/v11/LandingPage/bulk

Delete multiple Landing Pages at once.
- Parameters
- pages: Collection of Landing Page objects to delete (FromBody)
- version: (FromUri)

DELETE api/v11/LandingPage/bulk/url

Delete multiple Landing Pages at once.
Parameters
- pageUrls: Collection of Landing Page urls to delete (FromBody)
- version: (FromUri)

DELETE api/v11/LandingPage/bulk/guid

Delete multiple Landing Pages at once.
Parameters
- pages: Collection of Landing Page guids to delete (FromBody)
- version: (FromUri)

DELETE api/v11/LandingPage/url/{url}

Delete Landing Page with a particular url
Parameters
- url: Unique Url of the Landing Page (FromUri)
- version: (FromUri)

DELETE api/v11/LandingPage/custom/{custom}

Delete Landing Page by Custom field value
Parameters
- custom: Custom field value (FromUri)
- version: (FromUri)

Landing Page Other Methods - AllFacets

Overview
There are additional methods

All Facets
Retrieves All Facets available for display on a landing page

Request

GET /api/v11/LandingPage/AllFacets

[  
    {  
        "FacetId": 91540,  
        "Field": "itemname",  
        "Label": "New one",  
        "SortOrder": 14,  
        "SortBy": "ScoreAndAlphaAndAlpha"  
    },  
    {  
        "FacetId": 99,  
        "Field": "size-property",  
        "Label": "Size",  
        "SortOrder": 15,  
        "SortBy": "ScoreAndAlphaAndAlpha"  
    },  
    {  
        "FacetId": 25425,  
        "Field": "it",  
        "Label": "Tabs",  
        "SortOrder": 16,  
        "SortBy": "Custom"  
    }  
]

Other Landing Pages Methods

GET api/v11/LandingPage/AllFacets

Retrieves All Facets available for display
Parameters
- version: (FromUri)

📘API Docs

Using API to Get All Landing Pages

Using API to Get a Landing Page

Using API to Create Landing Pages

Using API to Update Landing Pages

Using API to Delete a Landing Page

Landing Page Other Methods - AllFacets

📘
API Docs