getKeywordRankings

Gibt alle URLs zu einem Keyword aus den SERPs (Search Engine Result Pages) zurück.

Route	/keywords/getKeywordRankings[/:key[/:keyword[/:sengine[/:format[/:limit[/:skip[/:date]]]]]]]
Erforderliche Parameter	keyword sengine
Optionale Parameter	format limit (max:1000) skip date
Rückgabewerte	url position
Querschnittverbindungen	getSearchEngines() – holen aller Suchmaschinen.
Hinweise	Limit: Das maximale Limit ist 1000. Um mehr Ergebnisse zu erhalten, benutzen Sie den Parameter Skip.

Parameter

Bezeichnung	Beschreibung	Wertebereich	Standardwert
keyword	Enthält eine Bezeichnung für ein Keyword.	(A-Z|a-z|0-9)+	–
sengine	Enthält eine von Xovi gecrawlte Suchmaschine.	google.de|google.at|google.ch| bing.de|yandex.com|baidu.com	–
date	Enthält ein Datum nach ISO8601	Datum: YYYY-MM-DD	Das Datum der Vorwoche
limit	Legt fest, wie viele Ergebniszeilen zurückgegeben werden sollen. (max:1000)	0-1000	10
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
url	Zeigt, die am besten rankende, URL an.	http[s]?://(www.)?(A-Z|a-z|0-9)+.(a-z)+
position	Die Position zum Zeitpunkt des Crawlings.	(0-9)+

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'  => 'getKeywordRankings',
     'key'     => 'yourPersonalKey',
     '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":[
        {
            "url":"http:\/\/de.wikipedia.org\/wiki\/Suchmaschinenoptimierung",
            "position":"1"
        },
        {
            "url":"http:\/\/de.wikipedia.org\/wiki\/Seo",
            "position":"2"
        },
        {
            "url":"http:\/\/www.seo-united.de\/",
            "position":"3"
        },
        { 
            "url":"http:\/\/suchmaschinenoptimierung.michaelsattler.de\/",
            "position":"4"
        },
        { 
            "url":"http:\/\/seo.de\/",
            "position":"5"
        }
    ]
}

XML

<?xml version="1.0"?>
<result>
    <apiErrorCode>0</apiErrorCode>
    <apiErrorMessage>0k.</apiErrorMessage>
    <apiResult>
        <keywordrankings>
            <keywordranking>
                <url>http://de.wikipedia.org/wiki/Suchmaschinenoptimierung</url>
                <position>1</position>
            </keywordranking>
            <keywordranking>
                <url>http://de.wikipedia.org/wiki/Seo</url>
                <position>2</position>
            </keywordranking>
            <keywordranking>
                <url>http://www.seo-united.de/</url>
                <position>3</position>
            </keywordranking>
            <keywordranking>
                <url>http://suchmaschinenoptimierung.michaelsattler.de/</url>
                <position>4</position>
            </keywordranking>
            <keywordranking>
                <url>http://seo.de/</url>
                <position>5</position>
            </keywordranking>
        </keywordrankings>
    </apiResult>
</result>