Search REST API: Links

Overview

Instructions to use REST API Links service.

Step-by-step guide

Service Name

links

Service URL

URL_SEARCH/INSTANCE_ID/links?INPUT_PARAMETERS

Input Parameters

Parameter	Description	Data Type	Mandatory

Parameter	Description	Data Type	Mandatory
q	The query for the request	String	Yes
lang	Set the language of the query	String	Yes
m	Set number of results	Integer	Yes
type	Set the type of links that you want to search by	String	No
portal	Set the portal	String	No
scope	Set the scope	String	No
user	Set the user	String	No
session	Set the session	String	No
jsonCallback	It is used to request using JSONP	String	No
For information about the user and session parameters please review the Tagging REST API NOTE : The values for the type parameter will be promoted (for Promoted Links), banner (for Promoted Banners) and direct (for Direct Links)

Examples

NOTE: The following code is just an example, do not copy and paste this for your use

Output

Parameter	Description

Parameter	Description
id	Link identifier (self generating value)
title	Link title. It may contain highlighted text (configured when the link is created in the dashboard)
subtitle	Link subtitle (configured when the link is created in the dashboard)
portal	Link portal (configured when the link is created in the dashboard)
scope	Link scope (configured when the link is created in the dashboard)
title_raw	Link title without highlighted text
url	Destination url (configured when the link is created in the dashboard)
trackable_url	Destination url but using the tagging system to register the click
imagename	Image url (configured when the link is created in the dashboard)

{
    banner: [ 
    {
        id: "546dd382e4b08960f81c1392",
        title: "Promoted Banner Test Link",
        subtitle: "",
        portal: "",
        scope: "",
        title_raw: "Promoted Banner Test Link",
        subtitle_raw: "",
        url: "http://www.testlink.com",
        trackable_url: "TRACKABLE_TEST_LINK",
        imagename: "IMAGE_NAME"
    }
    ],
    promoted: [
    {
        id: "546dd382e4b08960f81c1395",
        title: "Promoted Test Link",
        subtitle: "",
        portal: "",
        scope: "",
        title_raw: "Promoted Test Link",
        subtitle_raw: "",
        url: "http://www.testlink.com",
        trackable_url: "TRACKABLE_TEST_LINK",
        imagename: "IMAGE_NAME"
    }
    ],
    direct: [
    {
        id: "54a17583e4b08f7d3fcfd8a9",
        title: "Direct Test Link",
        subtitle: "",
        portal: "",
        scope: "",
        title_raw: "Direct Test Link",
        subtitle_raw: "",
        url: "http://www.testlink.com",
        trackable_url: "TRACKABLE_TEST_LINK",
        imagename: "IMAGE_NAME"
    }
    ]
}

Related Resources

[PLAYBOARD - LINKS] Use Links to promote key products with the Empathy Playboard

Search REST API: Links

Overview

Step-by-step guide

Service Name

Service URL

Input Parameters

Examples

Output

Related articles

Related Resources

[PLAYBOARD - LINKS] Use Links to promote key products with the Empathy Playboard