getLinktexts
Returns all link texts of the backlinks of one domain.
Route | /links/getLinktexts[/:key[/:domain[/:format[/:limit[/:skip]]]]] |
---|---|
Necessary parameter | domain |
Optional parameter | format skip limit (max:1000) |
Return values | text |
Cross references | – |
Hints | Limit: The maximum limit is 1000. To get further results 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-1000 | 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
Labeling | Description | Values margin |
---|---|---|
linktexts | A numeric array with the anchor texts of the backlinks. | numerical array with strings |
Messages
Message | Description |
---|---|
maximum limit exeeded | The maximum limit is reached. |
no access | The 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
<!--?php $root = 'https://suite.xovi.net/api/'; $arrayParams = array( 'service' =-->'links', <%%KEEPWHITESPACE%%> 'method' =>'getLinktexts', <%%KEEPWHITESPACE%%> 'key' =>'myPersonalKey', <%%KEEPWHITESPACE%%> 'domain' => 'www.xovi.de', <%%KEEPWHITESPACE%%> 'format' =>'xml', <%%KEEPWHITESPACE%%> ); $GETparams = implode('/', $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":[ {"text":"$ Xovi"}, {"text":"↪ zurWebsite"}, {"handle":"s15289"}] }
XML
<?xml version="1.0"?> <result> <apiErrorCode>0</apiErrorCode> <apiErrorMessage>0k.</apiErrorMessage> <apiResult> <linktexts> <linktext> <text>$ Xovi</text> </linktext> <linktext> <text>&#8618; zurWebsite</text> </linktext> <linktext> <handle>s15289</handle> </linktext> </linktexts> </apiResult> </result>