getBacklinks

Returns all link details of a backlink for one domain.

Route	/links/getBacklinks[/:key[/:domain[/:format[/:limit[/:skip]]]]]
Necessary parameter	domain
Optional parameter	format limit (max:1000) skip
Return values	linkingUrl anchor linksIntern linksExtern webtitle linkedUrl
Cross references	–
Hints	Limit: The maximum limit is 1000. To get more results, please use the parameter skip. resultCount: Shows the amount of the result without limits. Usefull for pagination.

Parameter

Labeling	Description	Values margin	Default value
domain	Contains a qualified domain name.	(www.)?(A-Z|a-z|0-9)+.(a-z)+	–
limit	Defines the amount of the returned results. (max:1000)	(0-9)+	100
skip	Defines the starting page of the result. One page equals the the value of limit.	(0-9)+	0
format	Defines in which format the result will be returned.	json|xml	json

Return values

A numerical array with the following entries

Labeling	Description	Values margin
linkingUrl	URL of the linking website.	string
anchor	Anchor text of a backlink.	string
linksIntern	Number of links on the website pointing to within the same website.	uint
linksExtern	Number of links on the website pointing to other websites.	uint
webtitle	Title of the linking website.	string
linkedUrl	URL to the linked site.	string

Messages

Message	Description
maximum limit exeeded	The maximum limit is reached.
no permission	This key has no access to this function.
internal error	An internal error occured.
param missing	A required parameter is missing.
param invalid	The value of a parameter is not valid.
result empty	The request was successful, but the result itself is empty.
cost error	The current credit amount is not sufficient to handle the request.
0k.	The processing was successful.

Exemplary code

$root = 'https://suite.xovi.net/api/';
$arrayParams = array(
'service' =>'links',
'method' =>'getBacklinks',
'key' =>'myPersonalKey',
'domain' => 'www.xovi.de',
'format' =>'json',
);
$GETparams = http_build_query($arrayParams);

$requestURL = $root.$GETparams;

if (!function_exists('curl_init')) die('cURL not available');

$ch = curl_init();
curl_setopt($ch, CURLOPT_SSL_VERIFYPEER, 0);
curl_setopt($ch, CURLOPT_SSL_VERIFYHOST, 0);
curl_setopt($ch, CURLOPT_URL, $requestURL);
curl_setopt($ch, CURLOPT_RETURNTRANSFER, true);

// Download the given URL, and return output
$output = curl_exec($ch);

// Close the cURL resource, and free system resources
curl_close($ch);

echo $output;

Exemplary results

JSON

{
 "apiErrorCode":"0",
 "apiErrorMessage":"0k.",
 "apiResult":[
     {
         "linkingUrl":"http:\/\/www.internetszene.de\/business-es-sind-die-kl...",
         "anchor":null,
         "linksIntern":"76",
         "linksExtern":"22",
         "webtitle":"» Business: Es sind die Kleinigkeiten \u2026...",
         "linkedUrl":"http:\/\/www.xovi.de?xovi_aid=4bb093c0bd172&xovi...",
     },
     {
         "linkingUrl":"http:\/\/www.gruenderszene.de\/allgemein\/funf-deutsc...",
         "anchor":"Xovi",
         "linksIntern":"161",
         "linksExtern":"125",
         "webtitle":"F\u00fcnf deutsche Internet-Unternehmen, die es 2015 n...",
         "linkedUrl":"http:\/\/www.xovi.de",
}
]

XML

<?xml version="1.0"?>
    <result>
        <apiErrorCode>0</apiErrorCode>
        <apiErrorMessage>0k.</apiErrorMessage>
        <apiResult>
            <backlinks>
                <backlink>
                    <linkingUrl>http://www.internetszene.de/...</linkingUrl>
                    <anchor></anchor>
                    <linksIntern>76</linksIntern>
                    <linksExtern>22</linksExtern>
                    <webtitle>&amp;raquo; Business: Es sind die...</webtitle>
                    <linkedUrl>http://www.xovi.de?xovi_aid=4bb...</linkedUrl>
                </backlink>
            </backlinks>
        </apiResult>
    </result>