getKeywords

Returns all ranking keywords for a domain.

Route	/keywords/getKeywords[/:key[/:urlpattern[/:sengine[/:format[/:limit[/:skip[/:date]]]]]]]
Necessary parameter	urlpattern sengine
Optional parameter	format limit (max:1000) skip date
Return value	url* keyword position change cpc sevo competitorDensity*
Cross references	getSearchEngines()
Hints	change:Is the Keyword new compared to previous week, the value of change is 199. 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. urlpattern:it is possible to analize one specific URL *: not shown in url-analysis

Parameter

Labeling	Description	Values margin	Default value
urlpattern	Contains a qualified domain name.	(www.|*)?(A-Z|a-z|0-9)+.(a-z|*)+	–
date	Contains a concrete date in ISO8601 format.	(0-9){4}-(0-9){2}-(0-9){2}	date from the week before
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
format	Defines in which format the result will be returned.	json|xml	json
sengine	Contains a search engine which is crawled by XOVI.	s. getSearchEngines()	–

Return values

Labeling	Description	Values margin
url	Shows the best ranking url.	http[s]?://(www.)?(A-Z|a-z|0-9)+.(a-z)+
keyword	Chosen keyword for the daily monitoring.	(A-Z|a-z|0-9)+
position	Contains the best position of a keyword in a certain period of time.	(0-9)+
change	Position change compared to previos week.	(0-9)+
cpc	cost per click	float
sevo	Position change compared to previos week.	int
competitorDensity	Position change compared to previos week.	float(0-100)

Messages

Message	Description
maximum limit exeeded	The maximum limit is reached.
no permission	The 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' =>'getKeywords',
    'key' =>'myPersonalKey',
    'urlpattern' =>'www.xovi.de',
    'sengine' => 'google.de',
    'format' => 'json'
 );
$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

{
 "apiErrorCode":"0",
 "apiErrorMessage":"0k.",
 "apiResult":[
     {
         "url":"http:\/\/www.xovi.de\/",
         "keyword":"abstrafung seo tool xovi",
         "position":"1",
         "cpc":25.59,
         "sevo":2900,
         "competitorDensity":31.00
     },
     {
         "url":"http:\/\/www.xovi.de\/",
         "keyword":"affiliate marketing analyse",
         "position":"1",
         "cpc":25.59,
         "sevo":2900,
         "competitorDensity":31.00
     }]
}

XML

<?xml version="1.0"?>
<result>
    <apiErrorCode>0</apiErrorCode>
    <apiErrorMessage>0k.</apiErrorMessage>
    <apiResult>
        <keywords>
            <keyword>
                <url>http://www.xovi.de/</url>
                <keyword>abstrafung seo tool xovi</keyword>
                <position>1</position>
                <cpc>25.59</cpc>
                <sevo>2900</sevo>
                <competitorDensity>31.00</competitorDensity>
            </keyword>
            <keyword>
                <url>http://www.xovi.de/</url>
                <keyword>affiliate marketing analyse</keyword>
                <position>1</position>
                <cpc>25.59</cpc>
                <sevo>2900</sevo>
                <competitorDensity>31.00</competitorDensity>
            </keyword>
        </keywords>
    </apiResult>
</result>