deleteKeywords

Removes added monitoring keywords from the daily crawling.

Route	/monitor/deleteKeywords[/:key[/:format[/:keyword[/:domain[/:sengineid[/:isRanking[/:posMin[/:posMax [/:posChangeMin[/:posChangeMax[/:resultsmin[/:resultsmax[/:ignoreUSearch[/:url[/:labelid[/:date[/:device[/:projectHash]]]]]]]]]]]]]]]]]]
Necessary parameters	keyword(s) – or – domain(s)
Optional parameters	format sengineid(s) isRanking posMin posMax posChangeMin posChangeMax resultsmin resultsmax ignoreUSearch url labelid(s) date device(s) projectHash
Return values	resultCount
Cross references	getSearchEngines() getLabels()
Hints	All parameters can be included in the route, or as GET or POST parameters. (s): All parameters marked with (s) can be sent either separately or in an array, e.g. „domain“ => „*.xovi.de/*“ or „domains“ => [„*.xovi.de/*“,“*.xovi.com/*“] resultCount: Contains the amount of deleted keywords.

Parameters

Labeling	Description	Value range	Default value
format	Sets the returned format.	json|xml	json
keyword	Contains the keyword.	string	–
domain	Contains a qualified domain name.	(www.)?(A-Z|a-z|0-9)+.(a-z)+	NULL (result independent from domain)
sengineid	Contains a distinct identifier for the search engine.	see getSearchEngines() (parameter: id)	NULL (result independent from sengineid)
isRanking	Defines whether keywords are shown that rank or do not rank.	-1: independent of ranking 1: only ranking 2: only not ranking	-1
posMin	Defines the minimum position.	int	0
posMax	Defines the maximum position.	int	120
posChangeMin	Defines the minimal change in position.	int	-120
posChangeMax	Defines the maximal change in position.	int	120
resultMin	Defines the lowest level of search volume.	int	0
resultMax	Defines the highest level of searchvolume	int	1000000000000
ignoreUSearch	Defines whether universal search should be considered in the result set or not.	-1: all keywords 1: only where universal search is ignored 2: only where universal search is considered	-1
url	Shows the url a certain domain ranks best with (given a certain keyword and a certain searchengine).	http[s]?://(www.)?(A-Z|a-z|0-9)+.(a-z)+	–
labelid	Contains a distinct identifier for a label assigned to the keyword.	see getLabels() (parameter: hash)	NULL (result independent from labelid if labelid is not set)
labelids	Contains one or more distict identifier for a label assigned to the keyword.	array of labelids see getLabels() (parameter: hash)	NULL (result independent from labelids if labelid is not set)
date	Sets the filter to a specific date.	YYYY-MM-DD	For each keyword the last individual crawl day.
device	Sets the filter to a specific device.	1 -> PC 2 -> Tablet 3 -> Smartphone	NULL (Filter turned off)
projectHash	ID of a project. (see getProjects)	(a-z|0-9){32}	NULL (all projects)

Messages

Message	Description
no permission	The key has no access to this function.
maximum limit exeeded	The maximum limit has been exceeded.
internal error	An internal error occured.
param missing	A required parameter is missing.
param invalid	The value of a parameter is not valid.
result empty	The request was successful, but the result itself is empty.
cost error	The current credit amount is not sufficient to handle the request.
0k.	The processing was successful.

Exemplary code

$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;

Exemplary results

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>