getRankingTrend

Gibt den Keyword- und Ranking-Verlauf einer Domain zurück.

Route	/keywords/getRankingTrend[/:key[/:urlpattern[/:sengine[/:date[/:format[/:limit[/:skip]]]]]]]
Erforderliche Parameter	urlpattern sengine
Optionale Parameter	date format limit (max:1000) skip
Rückgabewerte	date keywords rankings pageOneKeywords
Querschnittverbindungen	getSearchEngines() – über diese Funktion können Sie die benötigte Suchmaschine finden
Hinweise	sengine – Es werden ausschließlich die Suchmaschinen der wöchentlich gecrawlten Suchmaschinen akzeptiert. limit – Das maximale Limit ist 1000. Um mehr Ergebnisse zu erhalten, benutzen Sie den skip Parameter. resultCount – Enthält die Anzahl des Ergebnisses ohne Filter. Wird z.B. bei der Paginierung benötigt.

Parameter

Bezeichnung	Beschreibung	Wertebereich	Standardwert
urlpattern	Enthält einen qualifizierten Domainnamen.	(www.|*)?(A-Z|a-z|0-9)+. (a-z|*)+	–
sengine	Enthält eine von Xovi gecrawlte Suchmaschine.	s. getSearchengines()	–
date	Enthält eine Datum nach ISO8601	YYYY-MM-DD	letztes crawldatum
limit	Legt fest, wie viele Ergebniszeilen zurückgegeben werden sollen.(max:1000)	0-1000	100
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

Rückgabewerte

Bezeichnung	Beschreibung	Wertebereich
date	Zeigt das Datum an, an dem der dazugehörende OVI gemessen wurde	Datum: YYYY-MM-DD
keywords	Enthält die Anzahl Keywordsanzahl einer Domain zu einem bestimmten Zeitpunkt.	(0-9)+
rankings	Enthält die Anzahl Rankings einer Domain zu einem bestimmten Zeitpunkt.	(0-9)+
pageOneKeywords	Gibt die Anzahl der Rankings der ersten Google-Ergebnisseite einer Domain zu einem bestimmten Zeitpunkt an.	(0-9)+

Meldungen

Nachricht	Beschreibung
maximum limit exeeded	Das maximale Limit wurde überschritten.
no permission	Der Api-Key hat keine Erlaubnis auf diese Funktion zuzugreifen.
urlpattern not supported	Das URL Muster wird nicht unterstützt.
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'  => 'getRankingTrend',
    'key'     => 'myPersonalKey',
    'urlpattern' => urlencode('*.zalando.de/*'),
    'sengine' => 'google.de',
    'date'    => 'NULL',
    'format'  => 'json',
    'limit'   => 3,
);
$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-02-11",
            "keywords": 1000,
            "rankings": 800,
            "pageOneKeywords": 100
        },
        {
            "date": "2013-02-18",
            "keywords": 1000,
            "rankings": 800,
            "pageOneKeywords": 100
        },
        {
            "date": "2013-02-25",
            "keywords": 1000,
            "rankings": 800,
            "pageOneKeywords": 100
        }]
}

XML

<?xml version="1.0"?>
<result>
    <apiErrorCode>0</apiErrorCode>
    <apiErrorMessage>0k.</apiErrorMessage>
    <apiResult>
        <rankingTrends>
            <rankingTrend>
                <date>2013-02-18</date>
                <keywords>1000</keywords>
                <rankings>800</rankings>
                <pageOneKeywords>100</pageOneKeywords>
            </rankingTrend>
            <rankingTrend>
                <date>2013-02-25</date>
                <keywords>1000</keywords>
                <rankings>800</rankings>
                <pageOneKeywords>100</pageOneKeywords>
            </rankingTrend>
            <rankingTrend>
                <date>2013-03-04</date>
                <keywords>1000</keywords>
                <rankings>800</rankings>
                <pageOneKeywords>100</pageOneKeywords>
            </rankingTrend>
        </rankingTrends>
    </apiResult>
</result>