deleteKeywords

Entfernt die angelegten Monitoring-Keywords aus dem täglichen Crawling.

Route	/monitor/deleteKeywords[/:key[/:format[/:keyword[/:domain[/:sengineid[/:isRanking[/:posMin[/:posMax [/:posChangeMin[/:posChangeMax[/:resultsmin[/:resultsmax[/:ignoreUSearch[/:url[/:labelid[/:date[/:device[/:projectHash]]]]]]]]]]]]]]]]]]
Erforderliche Parameter	keyword(s) – oder – domain(s)
Optionale Parameter	format sengineid(s) isRanking posMin posMax posChangeMin posChangeMax resultsmin resultsmax ignoreUSearch url date labelid(s) device(s) projectHash
Rückgabewerte	resultCount
Querschnittverbindungen	getSearchEngines() getLabels()
Hinweise	Alle Parameter können in der Route angegeben werden oder auch als GET oder POST Parameter. (s): Alle mit (s) gekennzeichneten Parameter können sowohl einzeln als auch in einem Array übermittelt werden. z.B. „domain“ => „*.xovi.de/*“ oder „domains“ => [„*.xovi.de/*“,“*.xovi.com/*“] resultCount: Enthält die Anzahl der gelöschten Ergebnisse.

Parameter

Bezeichnung	Beschreibung	Wertebereich	Standardwert
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)
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)+	–
labelid	Enthält einen eindeutigen Bezeichner für ein dem Keyword zugeordnetes Label.	siehe getLabels() (Parameter: hash)	NULL (Result unabhängig von labelid, wenn labelids 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 labelid, wenn labelid zuzätzlich nicht gesetzt ist)
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)
projectHash	ID eines Projekts. (siehe getProjects)	(a-z|0-9){32}	NULL (alle Projekte)

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 = [
    'monitor', // service
    'deleteKeywords', // method
    'myPersonalKey', // key
    'json', // format
    'NULL', // keyword
    '*.xovi.de/*', // domain
    '1', // sengineid
];
$postParams = [
    'keywords' => [
        'xovi',
        'xovi seo',
    ],
];

foreach ($arrayParams as &$arrayParam) {
    $arrayParam = rawurlencode($arrayParam);
}
$routeParams = implode('/', $arrayParams);

$requestURL = $root . $routeParams;

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);
if (count($postParams)) {
    curl_setopt($ch, CURLOPT_POST, count($postParams));
    curl_setopt($ch, CURLOPT_POSTFIELDS, http_build_query($postParams));
}

// 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":{
        "success":true,
        "message":"2 rows deleted.",
        "count":2
    }
}

XML

<?xml version="1.0"?>
<result>
    <apiMeta>
        <resultCount>2</resultCount>
    </apiMeta>
    <apiErrorCode>0</apiErrorCode>
    <apiErrorMessage>0k.</apiErrorMessage>
    <apiResult>
        <monitorkeyworddeletes>
            <monitorkeyworddelete>
                <success>1</success>
                <message>2 rows deleted.</message>
                <count>2</count>
            </monitorkeyworddelete>
        </monitorkeyworddeletes>
    </apiResult>
</result>