getKeywords

Returns all keywords of a domain which are linked with Adwords.

Route	/sea/getKeywords[/:key[/:sengine[/:domain[/:format[/:limit[/:skip[/:startdate[/:enddate]]]]]]]]
Required Parameter	domain sengine
Optional Parameter	format limit (max:1000) skip date
return values	keyword position
cross references	–
hints	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	desciption	values margin	default value
domain	Contains qualified domainname.	(www.)?(A-Z|a-z|0-9)+. (a-z)+	–
limit	Defines the amount of the returned results. (max:1000)	0-1000	1
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
startdate	Contains a concrete date in ISO8601 format that indicates the first day in a daterange.	Datum: YYYY-MM-DD	enddate – 30 days
enddate	Contains a concrete date in ISO8601 format that indicates the end in the daterange.	Datum: YYYY-MM-DD	latest date
sengine	Contains a search engine which is crawled by XOVI.	see getSearchengines()	–

Return values

labeling	description	values margin
keyword	Contains a keyword.	(a-zA-Z)+
Position	Contains the position value of a keyword.	(0-9)+

Messages

message	description
maximum limit exeeded	The maximum limit is reached.
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(
<%%KEEPWHITESPACE%%> 'service' =>'sea',
<%%KEEPWHITESPACE%%> 'method' =>'getKeywords',
<%%KEEPWHITESPACE%%> 'key' =>'myPersonalKey',
<%%KEEPWHITESPACE%%> 'sengine' => 'google.de',
<%%KEEPWHITESPACE%%> 'domain' => 'www.xovi.de',
<%%KEEPWHITESPACE%%> 'format' =>'xml',
<%%KEEPWHITESPACE%%> );
$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": [
    {
      "keyword": "abstrafung seo tool xovi",
      "position": "2"
    },
    {
      "keyword": "arbeiten mit xovi",
      "position": "1"
    },
]
}
XML
<result>
    <apiErrorCode>0</apiErrorCode>
    <apiErrorMessage>0k.</apiErrorMessage>
    <apiResult>
        <keywords>
            <keyword>
                <keyword>abstrafung seo tool xovi</keyword>
                <position>2</position>
            </keyword>
            <keyword>
                <keyword>arbeiten mit xovi</keyword>
                <position>1</position>
            </keyword>
        </keywords>
    </apiResult>
</result>