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:

Click here to expand...

POST /api/v10/LandingPage HTTP/1.1
Host: dashboard-na.hawksearch.com
X-HawkSearch-ApiKey: USE_YOUR_API_KEY
Cache-Control: no-cache
Postman-Token: cd457184-4c00-a650-62f2-530f22a9a384

{
    "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:

Click here to expand...

POST /api/v10/LandingPage HTTP/1.1
Host: dashboard-na.hawksearch.com
X-HawkSearch-ApiKey: USE_YOUR_API_KEY
Cache-Control: no-cache
Postman-Token: cd457184-4c00-a650-62f2-530f22a9a384

{
    "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	Codification 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

Best Practices

REST URL: https://dev.hawksearch.net/api/v9/LandingPage

Method: POST

Authentication: Basic (Engine API Key)

When creating a new landing page, you need to make sure that the following attributes are always sent in the request payload otherwise the request would be invalid.

Click here to expand...

 {
    "IsFacetOverride":false,
    "Name":"Testing Landing Page",
    "CustomUrl":"/testinglandingpage"
}