getRankingColumn
Die Funktion gibt die Rankingverteilung der Domain zurück, also mit wie vielen Suchbegriffen die URL auf den Seiten 1 – 10 bei Google rankt.
| Route | /keywords/getRankingColumn[/:key[/:urlpattern[/:sengine[/:format]]]] |
|---|---|
| Erforderliche Parameter | urlpattern sengine |
| Optionale Parameter | format |
| Rückgabewerte | column rankings |
| Querschnittverbindungen | getSearchEngines() |
| Hinweise | – |
Parameter
keyword
| Bezeichnung | Beschreibung | Wertebereich | Standardwert |
|---|---|---|---|
| sengine | Enthält ein von Xovi gecrawlte Suchmaschine. | s. getSearchEngines() | – |
| urlpattern | Die beobachtete Domain. | (www.|*)?(A-Z|a-z|0-9)+.(a-z|*)+ | – |
| format | Legt fest in welchem Format das Ergebnis zurückgeliefert werden soll. | json|xml | json |
Rückgabewerte
| Bezeichnung | beschreibung | Wertebereich |
|---|---|---|
| column | Enthält eine Seitenzahl. | (0-9)+ |
| rankings | Enthält die Anzahl der Keywords, die auf einer Seite ranken. | (0-9)+ |
Meldungen
| Nachricht | Beschreibung |
|---|---|
| no permission | This key has no permission to access this function. |
| internal error | Ein interner Fehler ist aufgetreten. |
| param missing | Ein erforderlicher Parameter wurde nicht übergeben. |
| param invalid | Der Wert eines übergebenen Parameters ist nicht gültig. |
| result empty | Die Bearbeitung der Anfrage war erfolgreich, aber das Ergebnis ist leer. |
| cost error | Der aktuelle Kreditumfang reicht nicht aus, um die Anfrage zu bearbeiten. |
| 0k. | Die Bearbeitung der Anfrage war erfolgreich. |
Beispielcode
$root = 'https://suite.xovi.net/api/';
$arrayParams = array(
'service' => 'keywords',
'method' => 'getRankingColumn',
'key' => 'yourPersonalKey',
'urlpattern' => 'www.xovi.de',
'sengine' => 'google.de',
'format' => 'json',
);
$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;
Beispielergebnisse
JSON
{
"apiErrorCode":"0",
"apiErrorMessage":"0k.",
"apiResult":[
{"column":"1","rankings":"422"},
{"column":"2","rankings":"210"},
{"column":"3","rankings":"155"},
{"column":"4","rankings":"143"},
{"column":"5","rankings":"105"},
{"column":"6","rankings":"87"},
{"column":"7","rankings":"89"},
{"column":"8","rankings":"85"},
{"column":"9","rankings":"69"},
{"column":"10","rankings":"1"}
]
}
XML
<?xml version="1.0"?>
<result>
<apiErrorCode>0</apiErrorCode>
<apiErrorMessage>0k.</apiErrorMessage>
<apiResult>
<rankingcolumns>
<rankingcolumn>
<column>1</column>
<rankings>422</rankgins>
</rankingcolumn>
<rankingcolumn>
<column>2</column>
<rankings>210</rankgins>
</rankingcolumn>
<rankingcolumn>
<column>3</column>
<rankings>155</rankgins>
</rankingcolumn>
<rankingcolumn>
<column>4</column>
<rankings>143</rankgins>
</rankingcolumn>
<rankingcolumn>
<column>5</column>
<rankings>105</rankgins>
</rankingcolumn>
<rankingcolumn>
<column>6</column>
<rankings>87</rankgins>
</rankingcolumn>
<rankingcolumn>
<column>7</column>
<rankings>89</rankgins>
</rankingcolumn>
<rankingcolumn>
<column>8</column>
<rankings></rankgins>
</rankingcolumn>
<rankingcolumn>
<column>9</column>
<rankings>69</rankgins>
</rankingcolumn>
<rankingcolumn>
<column>10</column>
<rankings>1</rankgins>
</rankingcolumn>
</rankingcolumns>
</apiResult>
</result>
