getKeywordTrend

Gibt den Rankingverlauf eines Keywords zu einer Domain zurück.

Route	/keywords/getKeywordTrend[/:key[/:urlpattern[/:keyword[/:sengine[/:format[/:limit[/:skip[/:date]]]]]]]]
Erforderliche Parameter	keyword urlpattern sengine
Optionale Parameter	format limit (max:1000) skip date
Rückgabewerte	date position url
Querschnittverbindungen	getSearchEngines() – Über diese Funktion können Sie alle gecrawlten Suchmaschinen abfragen und als Wert des Parameters sengine übergeben.
Hinweise	sengine – Beachten Sie, dass hier nur die wöchentlich gecrawlten Suchmaschinen übergeben werden können. date – Als Default-Wert wird hier das aktuelle Datum gewählt. Limit: Das maximale Limit ist 1000. Um mehr Ergebnisse zu erhalten, benutzen Sie den Parameter Skip. resultCount: Enthält die Anzahl des Ergebnisses ohne Filter. Wird z.B. bei der Paginierung benötigt.

Parameter

Bezeichnung	Beschreibung	Wertebereich	Standardwert
keyword	Enthält eine Bezeichnung für ein Keyword.	(A-Z|a-z|0-9)+	–
urlpattern	Enthält einen qualifizierten Domainnamen.	(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	–
limit	Legt fest, wie viele Ergebniszeilen zurückgegeben werden sollen. (max:1000)	0-1000	1
skip	Legt fest, wie viele Seiten des Ergebnisarrays übersprungen werden sollen. Eine Seite entspricht dem Wert von limit.	(0-9)+	0
format	Legt fest in welchem Format das Ergebnis zurückgeliefert werden soll.	json|xml	json
date	Enthält ein Datum.	YYYY-MM-DD	aktuelles crawldatum

Rückgabewerte

Bezeichnung	Beschreibung	Wertebereich
date	Enthält das Datum, an dem die Keywordposition erfasst wurde.	Datum: YYYY-MM-DD
position	Zeigt die beste Position eines Keywords an, die zu einem bestimmten Zeitpunkt erfasst wurde.	(0-9)+
url	Zeigt die URL, mit der die Domain mit diesem Keyword am besten rankt.	(http://|https://) (www.)?(A-Z|a-z|0-9)+.(a-z)+

Meldungen

Nachricht	Beschreibung
maximum limit exeeded	Das maximale Limit wurde überschritten.
no permission	Der Schlüssel hat keinen Zugriff auf diese Funktion.
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'  => 'getKeywordTrend',
    'key'     => 'myPersonalKey',
    'urlpattern' => 'www.xovi.de',
    'keyword' => 'seo',
    '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":[
        {
            "date":"2013-03-10",
            "position":"7",
            "url":"http:\/\/www.xovi.de\/"
        }
    ]
}

XML

<?xml version="1.0"?>
<result>
    <apiErrorCode>0</apiErrorCode>
    <apiErrorMessage>0k.</apiErrorMessage>
    <apiResult>
        <keywords>
            <keyword>
                <date>2013-03-10</date>
                <position>7</position>
                <url>http://www.xovi.de/</url>
            </keyword>
        </keywords>
    </apiResult>
</result>