getKeywords

Gibt alle rankenden Keywords zu einer Domain zurück.

Route /keywords/getKeywords[/:key[/:urlpattern[/:sengine[/:format[/:limit[/:skip[/:date]]]]]]]
Erforderliche Parameter urlpattern
sengine
Optionale Parameter format
limit (max:1000)
skip
date

Rückgabewerte url*
keyword
position
change
cpc
sevo
competitorDensity*
Querschnittverbindungen getSearchEngines()
Hinweise change: Ist das Keyword neu zur Vorwoche, ist der Wert von Change ‚N‘.
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.
urlpattern: Hierbei ist auch die Analyse einer bestimmten URL möglich.
*: wird nicht bei der URL-Analyse angezeigt

Parameter

Bezeichnung Beschreibung Wertebereich Standardwert
urlpattern  Enthält einen qualifizierten Domainnamen. (www.|*)?(A-Z|a-z|0-9)+.(a-z|*)+
date  Enthält ein Datum nach ISO8601 „YYYY-MM-DD“ für den Sonntag einer Woche, da Daten einer Kalenderwoche immer am Sonntag veröffentlicht werden. (0-9){4}-(0-9){2}-(0-9){2} Das jüngste Datum der Vorwoche.
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
sengine Enthält eine von Xovi gecrawlte Suchmaschine. siehe getSearchEngines()

Rückgabewerte

Bezeichnung Beschreibung Wertebereich
url Zeigt, die am besten rankende, URL an. http[s]?://(www.|*)?(A-Z|a-z|0-9)+.(a-z|*)+
keyword Das beobachtete Keyword. (A-Z|a-z|0-9)+
position Die Position zum Zeitpunkt des Crawlings. (0-9)+
change Veränderung zur vorwoche. (0-9)+|N (N –> neu zur Vorwoche)
cpc Cost per Click float
sevo Suchvolumen int
competitorDensity Mittbewerberdichte in Prozent. float (0-100)

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' => 'getKeywords',
    'key' =>'myPersonalKey',
    'urlpattern' => 'www.xovi.de',
    '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:\/\/www.xovi.de\/",
         "keyword":"abstrafung seo tool xovi",
         "position":"1",
         "cpc":25.59,
         "sevo":2900,
         "competitorDensity":31.00
     },
     {
         "url":"http:\/\/www.xovi.de\/",
         "keyword":"affiliate marketing analyse",
         "position":"1",
         "cpc":34.45,
         "sevo":2500,
         "competitorDensity":30.00
     }]
}

XML

<?xml version="1.0"?>
<result>
    <apiErrorCode>0</apiErrorCode>
    <apiErrorMessage>0k.</apiErrorMessage>
    <apiResult>
        <keywords>
            <keyword>
                <url>http://www.xovi.de/</url>
                <keyword>abstrafung seo tool xovi</keyword>
                <position>1</position>
                <cpc>32.45<cpc>
                <sevo>2900</sevo>
                <competitorDensity>31.00</competitorDensity>
            </keyword>
            <keyword>
                <url>http://www.xovi.de/</url>
                <keyword>affiliate marketing analyse</keyword>
                <position>1</position>
                <cpc>34.45</cpc>
                <sevo>2500</sevo>
                <competitorDensity>30</competitorDensity>
            </keyword>
        </keywords>
    </apiResult>
</result>