getDomains
Gibt die angelegten Domains aus dem täglichen Crawling zurück.
Route | /monitor/getDomains[/:key[/:format[/:limit[/:skip[/:sengineid]]]]] |
---|---|
Erforderliche Parameter | – |
Optionale Parameter | format limit (max:1000) skip sengineid |
Rückgabewerte | domain |
Querschnittverbindungen | getSearchEngines() – Über diese Funktion kann man die sengineId beziehen |
Hinweise | Limit – Das maximale Limit ist 1000. Um mehr Ergebnisse zu erhalten, benutzen Sie den Parameter Skip. resultCount – Enthält die Anzahl des Ergebnisses ohne Filter. Wird z.B. bei der Paginierung benötigt. |
Parameter
Bezeichnung | Beschreibung | Wertebereich | Standardwert |
---|---|---|---|
limit | Legt fest, wie viele Ergebniszeilen zurückgegeben werden sollen. (max:1000) | (0-9)+ | 50 |
skip | Legt fest, wie viele Seiten des Ergebnisarrays übersprungen werden sollen. Eine Seite entspricht dem Wert von limit. | (0-9)+ | 0 |
format | Legt fest in welchem Format das Ergebnis zurückgeliefert werden soll. | json|xml | json |
sengineid | Enthält einen eindeutigen Bezeichner für die Suchmaschine. | (0-9)+ | 0 (Alle Suchmaschinen) |
Rückgabewerte
Bezeichnung | Beschreibung | Wertebereich |
---|---|---|
domain | Die angelegte Domain im täglichen Monitoring. | (www.)?(A-Z|a-z|0-9)+.(a-z)+ |
Meldungen
Nachricht | Beschreibung |
---|---|
maximum limit exeeded | Das maximale Limit wurde überschritten. |
no permission | Der Schlüssel hat keinen Zugriff auf diese Funktion. |
internal error | Ein interner Fehler ist aufgetreten. |
param missing | Ein erforderlicher Parameter wurde nicht übergeben. |
param invalid | Der Wert eines übergebenen Parameters ist nicht gültig. |
result empty | Die Bearbeitung der Anfrage war erfolgreich, aber das Ergebnis ist leer. |
cost error | Der aktuelle Kreditumfang reicht nicht aus, um die Anfrage zu bearbeiten. |
0k. | Die Bearbeitung der Anfrage war erfolgreich. |
Beispielcode
$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;
Beispielergebnisse
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>