getRank

Gibt die stärksten Domains innerhalb einer Suchmaschine sortiert nach OVI zurück.

Route	/keywords/getRank[/:key[/:sengine[/:format[/:limit[/:skip[/:projhash]]]]]]
Erforderliche Parameter	sengine
Optionale Parameter	format limit skip projhash
Rückgabewerte	domain currentSeorank pastSeorank absoluteSeorankDiff relativeSeorankDiff pastStaticOvi currentStaticOvi absoluteStaticOviDiff relativeStaticOviDiff pastKeywords currentKeywords absoluteKeywordsDiff relativeKeywordsDiff
Querschnittverbindungen	getProjects – über diese Funktion erhalten Sie die Hashes Ihrer Projekte 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
sengine	Enthält eine von Xovi gecrawlte Suchmaschine.	s. getSearchengines()	–
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
projhash	Reduziert das Ergebnis auf die dem Projekt zugeordneten Domains (Hauptdomain und Mitbewerber)	string	NULL

Rückgabewerte

Bezeichnung	Beschreibung	Wertebereich
domain	Rankende Domain	string
currentSeorank	Aktueller Rank	int
pastStaticOvi	Static OVI der Vorwoche	float
currentStaticOvi	Aktueller Static OVI	float
absoluteStaticOviDiff	Die Differenz des Static OVI in absoluten Zahlen.	int
relativeStaticOviDiff	Die Differenz des Static OVIs in %	float
pastKeywords	Anzahl der Keywords mit der die Domain in der Vorwoche rankte.	int
currentKeywords	Anzahl der Keywords mit der die Domain rankt.	int
absoluteKeywordsDiff	Die Differenz der Anzahl der Keywords in absoluten Zahlen.	int
relativeKeywordsDiff	Die Differenz der Anzahl der Keywords in %.	float
pastSeorank	Rank der Vorwoche	int
absoluteSeorankDiff	Absolute Postionsdifferenz zur Vorwoche	int
raltiveSeorankDiff	Relative Positionsdifferenz zur Vorwoche	float

Meldungen

Nachricht	Beschreibung
maximum limit exeeded	Das maximale Limit wurde überschritten.
no permission	Der Api-Key hat keine Erlaubnis auf diese Funktion zuzugreifen.
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'  => 'getRank',
    'key'     => 'myPersonalKey',
    'sengine' => 'google.de',
    'format'  => 'json',
    'limit'   => 1,
);
$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.",
    "apiMeta":{
        "resultCount":1000000
    }
    "apiResult":[
        {
            "domain":"wikipedia.org",
            "currentSeorank":2,
            "pastSeorank":1,
            "absoluteSeorankDiff":0,
            "relativeSeorankDiff":0,
            "pastStaticOvi":234948,
            "currentStaticOvi":233775,
            "absoluteStaticOviDiff":-1173.17,
            "relativeStaticOviDiff":-0.499332,
            "pastKeywords":1958542,
            "currentKeywords":1870326,
            "absoluteKeywordsDiff":-88216,
            "relativeKeywordsDiff":-4.5042
        }
    ]
}

XML

<?xml version="1.0"?>
<result>
    <apiMeta>
        <resultCount>1000000</resultCount>
    </apiMeta>
    <apiErrorCode>0</apiErrorCode>
    <apiErrorMessage>0k.</apiErrorMessage>
    <apiResult>
        <ranks>
            <rank>
                <domain>wikipedia.org</domain>
                <currentSeorank>2</currentSeorank>
                <pastSeorank>1</pastSeorank>
                <absoluteSeorankDiff>0</absoluteSeorankDiff>
                <relativeSeorankDiff>0</relativeSeorankDiff>
                <pastStaticOvi>234948</pastStaticOvi>
                <currentStaticOvi>233775</currentStaticOvi>
                <absoluteStaticOviDiff>-1173.17</absoluteStaticOviDiff>
                <relativeStaticOviDiff>-0.499332</relativeStaticOviDiff>
                <pastKeywords>1958542</pastKeywords>
                <currentKeywords>1879326</currentKeywords>
                <absoluteKeywordsDiff>-88216</absoluteKeywordsDiff>
                <relativeKeywordsDiff>-4.5042</relativeKeywordsDiff>
            </rank>
        </ranks>
    </apiResult>
</result>