getKeywordRankings

Gibt die TOP 100 Suchergebnisse zu einem angelegten Keyword.

Route	/monitor/getKeywordRankings[/:key[/:keyword[/:sengineid[/:format[/:limit[/:skip[/:date]]]]]]]
Erforderliche Parameter	keyword sengineid
Optionale Parameter	format limit (max:1000) skip date
Rückgabewerte	domain url page position usearch
Querschnittverbindungen	getSearchEngines() getDailyKeywords()
Hinweise	Fragen Sie die täglich gecrawlten Suchmaschinen mittels des Parameters ‚Interval‘ bei Aufruf von getSearchEngines() ab. 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
sengineid	Enthält einen eindeutigen Bezeichner für die Suchmaschine.	(0-9)+	–
keyword	Enthält eine Bezeichnung für ein Keyword.	(A-Z|a-z|0-9)+	–
date	Enthält ein Datum nach ISO8601	Datum: YYYY-MM-DD	Das Datum des Vortags
limit	Legt fest, wie viele Ergebniszeilen höchstens zurückgegeben werden sollen. (max:1000)	(0-9)+	120
skip	Legt fest, wie viele Zeilen des Ergebnisarrays übersprungen werden sollen.	(0-9)+	0
format	Legt fest in welchem Format das Ergebnis zurückgeliefert werden soll.	json|xml	json

Rückgabewerte

Bezeichnung	beschreibung	Wertebereich
position	Die Position zum Zeitpunkt der Ermittlung.	(0-9)+
domain	Enthält die Domain auf die das Suchergebnis zeigt.	(www.)?(A-Z|a-z|0-9)+.(a-z)+
page	Enthält die Seitennummer auf der die Domain im Suchergebnis gefunden wurde.	(0-9)+
url	Enthält die URL auf die das Suchergebnis zeigt.	http[s]?://(www.)?(A-Z|a-z|0-9)+.(a-z)+
usearch	Enthält den Typen des Universal Search Ergebnisses.	apps | authors | events | music | people | products | recipes | reviews | news | maps | images | video | other

Meldungen

Nachricht	Beschreibung
no permission	Der Schlüssel hat keinen Zugriff auf diese Funktion.
maximum limit exeeded	Das maximale Limit wurde überschritten.
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'  => 'getDailyKeywordRankings',
    'key'     => 'yourPersonalKey',
    'keyword' => 's.e.o',
    'sengineid' => 1,
    '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":[{
        "position":1,
        "domain":"de.wikipedia.org",
        "page":1,
        "url":"de.wikipedia.org\/wiki\/Suchmaschinenoptimierung",
        "usearch":""
     },
     {
         "position":2,
         "domain":"",
         "page":1,
         "url":"de.wikipedia.org\/wiki\/Seo",
         "usearch":""
     }]
}

XML

<?xml version="1.0"?>
<result>
    <apiErrorCode>0</apiErrorCode>
    <apiErrorMessage>0k.</apiErrorMessage>
    <apiResult>
        <dailykeywordrankings>
            <dailykeywordranking>
                <position>1</position>
                <domain>de.wikipedia.org</domain>
                <page>1</page>
                <url>de.wikipedia.org/wiki/Suchmaschinenoptimierung</url>
                <usearch></usearch>
            </dailykeywordranking>
            <dailykeywordranking>
                <position>2</position>
                <domain></domain>
                <page>1</page>
                <url>de.wikipedia.org/wiki/Seo</url>
                <usearch></usearch>
            </dailykeywordranking>
        </dailykeywordrankings>
    </apiResult>
</result>