Using API to Get a Landing Page

Owned by Joanna Giemzik (Unlicensed)
Last updated: Nov 04, 2022
1 min read

Overview

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

Request

GET /api/v10/LandingPage/1234 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

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 https://bridgeline.atlassian.net/wiki/spaces/HSKB/pages/3462502640

 

GET Methods

  • GET api/v9/LandingPage/{id}

    Returns Landing Page with a particular Id.

    Parameters

    • id: Unique Id of the Landing Page (FromUri)

    • version: (FromUri)

  • GET api/v9/LandingPage/{guid}

    Returns Landing Page with a particular Id.

    Parameters

    • guid: Unique Id of the Landing Page (FromUri)

    • version: (FromUri)

  • GET api/v9/LandingPage/urls

    Retrieves list of all available Landing Page URLs

    Parameters

    • version: (FromUri)

  • GET api/v9/LandingPage/Custom

    Retrieves all values of the Custom field in pages

    Parameters

    • version: (FromUri)

  • GET api/v9/LandingPage/url/{url}

    Returns Landing Page with a particular custom url

    Parameters

    • url: Custom url of the Landing Page (FromUri)

    • version: (FromUri)

  • GET api/v9/LandingPage/custom/{custom}

    Get Landing Page entity by Custom field

    Parameters

    • custom: Custom field value (FromUri)

    • version: (FromUri)