getRankingValue
Gibt den Wert einer Domain errechnet aus Position, Suchvolumen, CPC und Trafficfaktor zu einem bestimmten Zeitpunkt zurück.
| Route | /keywords/getRankingValue[/:key[/:urlpattern[/:sengine[/:format[/:date]]]]] |
|---|---|
| ERFORDERLICHE PARAMETER | urlpattern sengine |
| OPTIONALE PARAMETER | format date |
| RÜCKGABEWERTE | rankingvalue |
| QUERSCHNITTVERBINDUNGEN | getSearchEngines() |
| HINWEISE | – |
Parameter
| BEZEICHNUNG | BESCHREIBUNG | WERTEBEREICH | STANDARDWERT |
|---|---|---|---|
| urlpattern | Enthält ein Url Muster. | (www.|*)?(A-Z|a-z|0-9)+.(a-z|*)+ | – |
| sengine | Enthält eine von Xovi gecrawlte Suchmaschine. | google.de|google.at|google.ch| bing.de |
– |
| date | Enthält ein Datum nach ISO8601 | Datum: YYYY-MM-DD | Das Datum der Vorwoche |
| format | Legt fest in welchem Format das Ergebnis zurückgeliefert werden soll. | json|xml | json |
Rückgabewerte
| BEZEICHNUNG | BESCHREIBUNG | WERTEBEREICH |
|---|---|---|
| rankingvalue | Zeigt den Wert einer Domain. |
Meldungen
| NACHRICHT | BESCHREIBUNG |
|---|---|
| no permission | Der Schlüssel hat keinen Zugriff auf diese Funktion. |
| urlpattern not supported | Die übergebene Url kann in der Form nicht verarbeitet werden. |
| 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' => 'getRankingValue',
'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":{
"rankingvalue":"552728.88"
}
}
XML
<?xml version="1.0"?>
<result>
<apiErrorCode>0</apiErrorCode>
<apiErrorMessage>0k.</apiErrorMessage>
<apiResult>
<rankingvalues>
<rankingvalue>
<rankingvalue>552728.88</rankingvalue>
</rankingvalue>
</rankingvalues>
</apiResult>
</result>
