getDomains

Returns the created domains of the daily crawling.

Route	/monitor/getDomains[/:key[/:format[/:limit[/:skip[/:sengineid]]]]]
Necessary parameter	–
Optional parameter	format limit (max:1000) skip sengineid
Return values	domain
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	Description	Values margin	Default value
limit	Defines the amount of the returned results. (max:1000)	(0-9)+	50
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
sengineid	Contains a unique identifier for the returned search engine.	(0-9)+	0 (All search engines)

Return values

Labeling	Description	Values margin
domain	Chosen domain for the daily monitoring.	(www.)?(A-Z|a-z|0-9)+.(a-z)+

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' =>'getDailyDomains',
        'key' =>'myPersonalKey',
	'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":[
		{
			"domain":"www.xovi.de"
		}
	]
}

XML

<!--?xml version="1.0"?-->
<result>
   <apiErrorCode>0</apiErrorCode>
   <apiErrorMessage>0k.</apiErrorMessage>
   <apiResult>
      <dailydomains>
         <dailydomain>
            <domain>xovi.de</domain>
         </dailydomain>
      </dailydomains>
   </apiResult>
</result>