getNewKeywords

Gibt alle neu rankenden Keywords einer Domain aus einer Suchmaschine zurück.

Route /keywords/getNewKeywords[/:key[/:urlpattern[/:sengine[/:format[/:limit[/:skip[/:date]]]]]]]
ERFORDERLICHE PARAMETER urlpattern
sengine

OPTIONALE PARAMETER format
limit (max:1000)
skip
date
RÜCKGABEWERTE keyword
position
QUERSCHNITTVERBINDUNGEN getSearchEngines()
HINWEISE 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
urlpattern Enthält einen qualifizierten Domainnamen. (www.|*)?(A-Z|a-z|0-9)+.(a-z|*)+
sengine Enthält eine von Xovi gecrawlte Suchmaschine. siehe getSearchEngines()
date Enthält ein Datum nach ISO8601 Datum: YYYY-MM-DD Das Datum der Vorwoche
format Legt fest in welchem Format das Ergebnis zurückgeliefert werden soll. json|xml json
limit Legt fest, wie viele Zeilen zurückgeliefert 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)+ 100

Rückgabewerte

BEZEICHNUNG BESCHREIBUNG WERTEBEREICH
keyword Enthält ein Keyword. (A-Z|a-z|0-9)+
position Enthält die aktuelle Position des Keywords.  (0-9)+

Meldungen

NACHRICHT BESCHREIBUNG
maximum limit exeeded Das maximale Limit wurde überschritten.
no permission Der Schlüssel hat keinen Zugriff auf diese Funtkion.
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' =>'getNewKeywords',
     'key' =>'yourPersonalKey',
     'urlpattern' =>'xovi.de',
     'sengine' => 'google.de',
 );
$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":[
    {"keyword":"21.m\u00e4rz domain verschwunden google",
     "position":"40"},
    {"keyword":"affiliate forum",
     "position":"39"}]
}

XML

<!--?xml version="1.0"?-->
<result>
 <apiErrorCode>0</apiErrorCode>
 <apiErrorMessage>0k.</apiErrorMessage>
 <apiResult>
     <newkeywords>
         <newkeyword>
             <keyword>21.m&#xE4;rz domain verschwunden google</keyword>
             <position>40</position>
         </newkeyword>
         <newkeyword>
             <keyword>affiliate forum</keyword>
             <position>39</position>
         </newkeyword>
     </newkeywords>
 </apiResult>
</result>