getKeywordTrend

Gibt den täglichen Rankingverlauf eines Keywords zu einer Domain zurück.

Route /monitor/getKeywordTrend[/:key[/:sengineid[/:domain[/:keyword[/:format[/:limit[/:skip[/:ignoreUSearch]]]]]]]]
Erforderliche Parameter sengineid
domain
keyword
Optionale Parameter format
limit (max:1000)

skip
ignoreUSearch
Rückgabewerte crawlDate
crawlTime
position
positionChange
url
universalSearch
Querschnittverbindungen getSearchEngines() – Über diese Funktion kann man die sengineId beziehen
getDailyKeywords() – Überblick über die angelegten Keywords des monatlichen Crawlings
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
sengineid Enthält einen eindeutigen Bezeichner für die Suchmaschine. (0-9)+
domain Enthält einen qualifizierten Domainnamen. (www.)?(A-Z|a-z|0-9)+.(a-z)+
keyword Enthält eine Bezeichnung für ein Keyword. (A-Z|a-z|0-9)+
limit Legt fest, wie viele Ergebniszeilen zurückgegeben werden sollen. (max:1000) (0-9)+ 1
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
ignoreUSearch Legt fest, ob die Keywords angezeigt werden sollen, wo Universal Search ignoriert wird oder nicht. -1: Alle Keywords
1: Nur wo Universal Search ignoriert wird
2: Nur wo Universal Search berücksichtigt wird
-1

Rückgabewerte

Bezeichnung Beschreibung Wertebereich
crawlDate Das Datum, an dem das Ranking ermittelt wurde. Datum: YYYY-MM-DD
crawlTime Die Uhrzeit, an dem das Ranking ermittelt wurde. Uhrzeit: HH:II:SS
position Die Position, welche zum Zeitpunkt ermittelt wurde. (0-9)+
positionChange Zeigt den Rankingwertunterschied zum Vortag. (0-9)+
url Zeigt die am besten rankende URL an. http[s]?://(www.)?(A-Z|a-z|0-9)+.(a-z)+
universalSearch Zeigt den Universal Search Typ an. apps | authors | events | music | people | products | recipes | reviews | news | maps | images | video | other

Meldungen

Nachricht Beschreibung
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'	=> 'getDailyKeywordTrend',
    'key'	=> 'myPersonalKey',
    'sengineId'	=> 1,
    'domain'	=> 'www.xovi.de',
    'keyword'	=> 'seo',
    'format'	=> 'xml',
 );
$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":[
        {
            "crawlDate":"2013-03-13",
            "crawlTime":"13:34:17",
            "position":"7.00",
            "positionChange":"-1.00",
            "url":"http:\/\/www.xovi.de\/",
            "universalSearch":""
        }
    ]
}

XML

<?xml version="1.0"?>
<result>
    <apiErrorCode>0</apiErrorCode>
    <apiErrorMessage>0k.</apiErrorMessage>
    <apiResult>
        <dailykeywords>
            <dailykeyword>
                <crawlDate>2013-03-13</crawlDate>
                <crawlTime>13:34:17</crawlTime>
                <position>7.00</position>
                <positionChange>-1.00</positionChange>
                <url>http://www.xovi.de/</url>
                <universalSearch></universalSearch>
            </dailykeyword>
        </dailykeywords>
    </apiResult>
</result>