getNewKeywords

Returns the new ranking keywords of a domain within a searchengine.

Route	/keywords/getNewKeywords[/:key[/:urlpattern[/:sengine[/:format[/:limit[/:skip[/:date]]]]]]]
Necessary parameter	urlpattern sengine
Optional parameter	format limit (max:1000) skip date
Return value	keyword position
Cross reference	getSearchEngines()
Hint	Limit: The maximum limit is 1000. To get more results, please use the parameter skip. resultCount – Shows the amount of the result without limits. Usefull for pagination.

Parameter

Labeling	Description	Values margin	Default value
urlpattern	Contains a qualified domain name.	(www.|*)?(A-Z|a-z|0-9)+.(a-z|*)+	–
sengine	Contains a search engine which is crawled by XOVI.	see getSearchEngines	–
date	Contains a concrete date in ISO8601 format.	Datum: YYYY-MM-DD	date from the week before
format	Defines in which format the result will be returned.	json|xml	json
limit	Defines the amount of the returned results. (max:1000)	0-1000	100
skip	Defines the starting page of the result. One page equals the the value of limit.	(0-9)+	0

Return values

Labeling	Description	Values margin
keyword	Contains a keyword.	(A-Z|a-z|0-9)+
position	Contains the position value of a keyword.	(0-9)+

Messages

Message	Description
maximum limit exeeded	The maximum limit is reached.
no access	This key has no access to this function.
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 = 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;
?>

Exemplary results

JSON

{
<%%KEEPWHITESPACE%%>    "apiErrorCode":0,
<%%KEEPWHITESPACE%%>    "apiErrorMessage":"0k.",
<%%KEEPWHITESPACE%%>    "apiResult":[
<%%KEEPWHITESPACE%%>        {"keyword":"21.m\u00e4rz domain verschwunden google",
<%%KEEPWHITESPACE%%>         "position":"40"},
<%%KEEPWHITESPACE%%>        {"keyword":"affiliate forum",
<%%KEEPWHITESPACE%%>         "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>