/
Using API to Get All Landing Page Layout

Using API to Get All Landing Page Layout

Overview

This API allows you to retrieve all Landing Pages Layouts created in the Hawksearch dashboard.

Request: GET request to the API below:

GET /api/v9/LandingPageLayout HTTP/1.1 Host: dashboard-na.hawksearch.com X-HawkSearch-ApiKey: USE_YOUR_API_KEY Content-Type: application/json Accept: application/json Cache-Control: no-cache

 

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

[ { "PageLayoutId": 3, "Name": "3 Images (Top), 1 Zone (Bottom)", "Layout": "<div class=\"grid_12\">\r\n <div class=\"grid_4\">\r\n {{Image1}}\r\n </div>\r\n <div class=\"grid_4\">\r\n {{Image2}}\r\n </div> \r\n <div class=\"grid_4\">\r\n {{Image3}}\r\n </div> \r\n</div>\r\n<div class=\"grid_12\">\r\n {{WidgetZone}}\r\n</div>", "AssetName": "icon_Column_25.gif", "CreateDate": "01-01-0001", "ModifyDate": "01-01-0001" }, { "PageLayoutId": 1, "Name": "4 Example Zones", "Layout": "<h1>\r\n Hawk Search Landing Page Content Examples\r\n</h1>\r\n<div>\r\n <h4 style='color:#F47622'>\r\n HTML Content\r\n </h4>\r\n <div>\r\n {{HTML Content}} \r\n </div> \r\n</div>\r\n<div>\r\n <h4 style='color:#F47622'>\r\n Image Content\r\n </h4>\r\n <div>\r\n {{Image Content}} \r\n </div> \r\n</div>\r\n<div>\r\n <h4 style='color:#F47622'>\r\n Popular Searches\r\n </h4>\r\n <div>\r\n {{Popular Searches}} \r\n </div> \r\n</div>\r\n<div>\r\n <h4 style='color:#F47622'>\r\n Rich \"What You See Is What You Get\" Text Editor\r\n </h4>\r\n <div>\r\n {{Rich Text}} \r\n </div> \r\n</div>\r\n", "AssetName": "icon_Column_23.gif", "CreateDate": "01-01-0001", "ModifyDate": "01-01-0001" }, ... ]

 

No

Key

Description

Value Type

No

Key

Description

Value Type

1

PageLayoutId

The unique identifier of the landing page layout(unique across the whole system)

Number

3

Name

Title for landing page layout.

String

5

Layout

The HTML with a layout definition

String

6

CreateDate

Creation date

Date string in MM-DD-YYYY format

7

ModifyDate

Modification date

Date string in MM-DD-YYYY format