getKeywords

Gibt die angelegten Monitoring-Keywords aus dem täglichen Crawling zurück.

Route	/monitor/getKeywords[/:key[/:format[/:limit[/:skip[/:keyword[/:domain[/:sengineid[/:isRanking [/:posMin[/:posMax[/:posChangeMin[/:posChangeMax[/:resultsmin[/:resultsmax[/:ignoreUSearch[/:url[/:labelid[/:date[/:device]]]]]]]]]]]]]]]]]]]
Erforderliche Parameter	–
Optionale Parameter	format limit (max: 1000) skip keyword domain sengineid isRanking posMin posMax posChangeMin posChangeMax resultsmin resultsmax ignoreUSearch url labelid labelids (POST) date device
Rückgabewerte	keyword domain sengineId labels crawlDateTime isRanking position positionChange universalSearch organicType ignoreUSearch url keywordInserted sevo cpc device posChangeSinceBeginning
Querschnittverbindungen	getSearchEngines() getLabels()
Hinweise	Limit: Das maximale Limit ist 1000. Um mehr Ergebnisse zu erhalten, benutzen Sie den Parameter skip. Date: Es werden die Daten ausgegeben, die zu dem Zeitpunkt erhoben wurden (sofern mit übergeben). Anderenfalls werden für jedes Keyword die Daten des individuellen Crawltages ausgegeben. Das Datenset besteht aus grundlegenden Eigenschaften des Keywords und variablen Daten (zeitlich abhängig): Eigenschaften: keyword, keywordInserted, domain, sengineId, labelId, device, ignoreUSearch, sevo (nicht täglich aktualisiert), cpc (nicht täglich aktualisiert) Variable Daten: crawlDateTime, isRanking, position, positionChange, universalSearch, url (ist das Keyword zu dem gewählten Zeitpunkt nicht angelegt worden, oder der Crawlinterval liegt nicht in dem Zeitpunkt, haben die Variablen den Wert NULL) universalSearch: Der Wert NULL entspricht einem organischen Suchergebnis. POST: Alle mit POST gekennzeichneten Parameter müssen auch per POST übermittelt werden. resultCount: Enthält die Anzahl des Ergebnisses ohne Filter. Wird z.B. bei der Paginierung benötigt.

Parameter

Bezeichnung	Beschreibung	Wertebereich	Standardwert
limit	Legt fest, wie viele Ergebniszeilen zurückgegeben werden sollen. (max:1000)	int	100
skip	Legt fest, wie viele Seiten des Ergebnisarrays übersprungen werden sollen. Eine Seite entspricht dem Wert von limit.	int	0
format	Legt fest in welchem Format das Ergebnis zurückgeliefert werden soll.	json|xml	json
keyword	Enthält eine Bezeichnung für ein Keyword.	string	–
domain	Enthält einen qualifizierten Domainnamen.	(www.)?(A-Z|a-z|0-9)+.(a-z)+	NULL (Result unabhängig von domain)
sengineid	Enthält einen eindeutigen Bezeichner für die Suchmaschine.	siehe getSearchEngines() (Parameter: id)	NULL (Result unabhängig von sengineid)
labelid	Enthält einen eindeutigen Bezeichner für ein dem Keyword zugeordnetes Label.	siehe getLabels() (Parameter: hash)	NULL (Result unabhängig von labelid, wenn labelid zusätzlich nicht gesetzt sind)
labelids	Enthält einen oder mehrere eindeutigen Bezeichner für ein dem Keyword zugeordnetes Label.	array mit labelids siehe getLabels() (Parameter: hash)	NULL (Result unabhängig von labelids, wenn labelids zuzätzlich nicht gesetzt ist)
isRanking	Legt fest, ob die Keywords angezeigt werden sollen, die ranken oder nicht.	-1: unabhängig von Ranking 1: Nur rankende 2: Nur nicht rankende	-1
posMin	Legt die kleinste Position fest.	int	0
posMax	Legt die größte Position fest.	int	120
posChangeMin	Legt die kleinste Veränderung bei der Position fest.	int	-120
posChangeMax	Legt die größte Veränderung bei der Position fest.	int	120
resultMin	Legt die kleinste Anzahl an Suchvolumen fest.	int	0
resultMax	Legt die größte Anzahl an Suchvolumen fest.	int	1000000000000
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
url	Legt fest, ob die Keywords angezeigt werden sollen, wo diese am besten rankende URL vorkommt.	http[s]?://(www.)?(A-Z|a-z|0-9)+.(a-z)+	–
date	Filtert einen Crawlzeitpunkt heraus.	YYYY-MM-DD	Für jedes Keyword der letzte individuelle Crawltag.
device	Filtert das Ergebnis nach einem Endgerät.	1 -> PC 2 -> Tablet 3 -> Smartphone	NULL (Filter ausgeschaltet)

Rückgabewerte

Bezeichnung	Beschreibung	Wertebereich
keyword	Das beobachtete Keyword.	string
domain	Die beobachtete Domain.	string
sengineid	Enthält einen eindeutigen Bezeichner der Suchmaschine.	int
crawlDateTime	Zeigt Datum und Uhrzeit, an dem das Ranking ermittelt wurde.	Datum und Uhrzeit: YYYY-MM-DD HH:II:SS (oder NULL falls das Keyword zu dem Zeitpunkt nicht gecrawled wurde)
isRanking	Zeigt an, ob das Keyword rankt.	1|0
position	Die Position zum Zeitpunkt des Crawlings.	int|-120
positionChange	Zeigt den Rankingwertunterschied zum Vortag.	int
universalSearch	Zeigt den Universal Search Typ an.	apps | authors | events | music | people | products | recipes | reviews | news | maps | images | video | other| NULL (enspricht organischem Ergebnis)
ignoreUSearch	Zeigt an, ob bei den Keywords Universal Search ignoriert wird oder nicht.	1|0
organicType	Zeigt den organischen Search Typ an.	apps | authors | events | music | people | products | recipes | reviews | news | maps | images | video | other| NULL (entspricht normalem organischen Ergebnis)
url	Zeigt die am besten rankende URL an.	string
keywordInserted	Zeigt an, wann das Keyword angelegt wurde.	Datum und Uhrzeit: YYYY-MM-DD HH:II:SS
sevo	Enthält das Suchvolumen.	integer
cpc	Enthält cost per click.	float
device	Enthält die Device Id.	1 -> PC 2 -> Tablet 3 -> Smartphone
labels	Enthält die dem Keyword zugeordneten Labels	array
posChangeSinceBeginning	Zeigt die Positionsveränderung seit Beginn der Optimierung.	number (-199 entspicht einem gewonnen Keyword, 199 entspricht einem verlorenen Keyword )

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'   => 'monitor',
    'method'    => 'getKeywords',
    'key'       => 'myPersonalKey',
    '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.",
    "apiMeta":{
        "resultCount":2
    },
    "apiResult":[
        {
            "keyword":"rankinganalyse",
            "keywordInserted":"2021-01-13 13:08:42",
            "domain":"xovi.de",
            "sengineId":1,
            "labels":{"names":"Label-01;Label-02;Label-03"},
            "device":1,
            "ignoreUSearch":0,
            "sevo":300,
            "cpc":4.35,
            "crawlDateTime":"2021-03-10 17:35:29",
            "isRanking":0,
            "position":10,
            "positionChange":2,
            "universalSearch":"",
            "organicType":"0",
            "url":"",
            "posChangeSinceBeginning":-3
        },
        {
            "keyword":"seotool",
            "keywordInserted":"2021-01-13 13:06:10",
            "domain":"xovi.de",
            "sengineId":1,
            "labels":{"names":""}
            "device":1,
            "ignoreUSearch":0,
            "sevo":400, 
            "cpc":3.52,
            "crawlDateTime":"2021-03-10 17:37:24",
	    "isRanking":1,
	    "position":23,
	    "positionChange":5,
	    "universalSearch":"",
            "organicType":"0",
            "url":"www.xovi.de\/xovi-tool\/seo-tool\/",
            "posChangeSinceBeginning":15
	}
    ]
}

XML

<?xml version="1.0"?>
<result>
    <apiMeta>
        <resultCount>2</resultCount>
    </apiMeta>
    <apiErrorCode>0</apiErrorCode>
    <apiErrorMessage>0k.</apiErrorMessage>
    <apiResult>
        <dailykeywords>
            <dailykeyword>
                <keyword>rankinganalyse</keyword>
                <keywordInserted>2021-01-13 13:08:42</keywordInserted>
                <domain>xovi.de</domain>
                <sengineId>1</sengineId>
                <labels>
                    <names>Label-01;Label-02;Label-03</names>
                </labels>
                <device>1</device>
                <ignoreUSearch>0</ignoreUSearch>
                <sevo>300</sevo>
                <cpc>3.45</sevo>
                <crawlDateTime>2021-03-10 17:35:29</crawlDateTime>
                <isRanking>0</isRanking>
                <position>10</position>
                <positionChange>2</positionChange>
                <universalSearch></universalSearch>
                <organicType>0</organicType>
                <url></url>
                <posChangeSinceBeginning>-3</posChangeSinceBeginning>
            </dailykeyword>
            <dailykeyword>
                <keyword>seotool</keyword>
                <keywordInserted>2021-01-13 13:06:10</keywordInserted>
                <domain>xovi.de</domain>
                <sengineId>1</sengineId>
                <labels>
                    <names></names>
                </labels>
                <device>1</device>
                <ignoreUSearch>0</ignoreUSearch>
                <sevo>400</sevo> 
                <cpc>3.67</cpc>
                <crawlDateTime>2013-03-10 17:37:24</crawlDateTime>
                <isRanking>1</isRanking>
                <position>23</position>posMin
                <positionChange>5</positionChange>
                <universalSearch></universalSearch>
                <organicType>0</organicType>
                <url>www.xovi.de/xovi-tool/seo-tool/</url>
                <posChangeSinceBeginning>15</posChangeSinceBeginning>
            </dailykeyword>
        </dailykeywords>
    </apiResult>
</result>