Returns the strongest domains within a searchengine ordered by OVI.
| Route | /keywords/getRank[/:key[/:sengine[/:format[/:limit[/:skip]]]]] |
|---|---|
| required parameter | sengine |
| Optionalparameters | format limit skip |
| return values | domain currentSeorank pastSeorank pastOvi currentOvi absoluteOviDiff relativeOviDiff pastKeywords currentKeywords absoluteKeywordsDiff relativeKeywordsDiff |
| crossreferences | getSearchEngines() – get the crawled searchengines with this functions |
| Hints | sengine – choose only the weekly crawled searchengines limit – The maximum limit is 1000. To get more results, use the skip parameter. |
Parameters
| Labeling | description | valuemargin | defaultvalue |
|---|---|---|---|
| sengine | contains the name of a weekly crawled searchengine. | s. getSearchengines() | – |
| 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 |
Returnvalues
| labeling | description | valuemargin |
|---|---|---|
| domain | Ranking domain | string |
| currentSeorank | Current rank | (0-9)+ |
| pastOvi | OVI of previouse week. | (0-9)+ |
| currentOvi | Current OVI | (0-9)+ |
| absoluteOviDiff | The difference of the OVI in absolute numbers. | (0-9)+ |
| relativeOviDiff | The difference of the OVI in percent. | (0-9)+ |
| pastKeywords | Number of keywords the domain ranked the week before. | (0-9)+ |
| currentKeywords | Number of domains the domain is ranking with. | (0-9)+ |
| absoluteKeywordsDiff | The difference of the number of the keywords in absolute numbers. | (0-9)+ |
| relativeKeywordsDiff | The difference of the number of the keywords in percent. | (0-9)+ |
| pastSeorank | Rank of the week. | (0-9)+ |
Messages
| Message | description |
|---|---|
| maximum limit exeeded | The maximum limit is reached. |
| no permission | The Api key has no permission to access 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. |
Example Code
$root = 'https://suite.xovi.net/api/';
$arrayParams = array(
'service' =>'keywords',
'method' =>'getRank',
'key' =>'myPersonalKey',
'sengine' =>'google.de',
'format' => 'json',
'limit' => 1
);
$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;
?>
Example Results
JSON
{
"apiErrorCode":0,
"apiErrorMessage":"0k.",
"apiMeta":{
"resultCount":1000000
}
"apiResult":[
{
"domain":"wikipedia.org",
"currentSeorank":2,
"pastSeorank":1,
"pastOvi":234948,
"currentOvi":233775,
"absoluteOviDiff": -1173.17,
"relativeOviDiff": -0.499332,
"pastKeywords": 1958542,
"currentKeywords": 1870326.
"absoluteKeywordsDiff": -88216,
"relativeKeywordsDiff": -4.5042
}
]
}
XML
<?xml version="1.0"?>
<result>
<apiMeta>
<resultCount>1000000</resultCount>
</apiMeta>
<apiErrorCode>0</apiErrorCode>
<apiErrorMessage>0k.</apiErrorMessage>
<apiResult>
<ranks>
<rank>
<domain>wikipedia.org</domain>
<currentSeorank>2</currentSeorank>
<pastSeorank>1</pastSeorank>
<pastOvi>234948</pastOvi>
<currentOvi>233775</currentOvi>
<absoluteOviDiff>-1173.17</absoluteOviDiff>
<relativeOviDiff>-0.499332</relativeOviDiff>
<pastKeywords>1958542</pastKeywords>
<currentKeywords>1879326</currentKeywords>
<absoluteKeywordsDiff>-88216</absoluteKeywordsDiff>
<relativeKeywordsDiff>-4.5042</relativeKeywordsDiff>
</rank>
</ranks>
</apiResult>
</result>
