getPages

Gibt alle Unterseiten einer Url zurück.

Route /keywords/getPages[/:key[/:urlpattern[/:sengine[/:format[/:limit[/:skip[/:date[/:keyword]]]]]]]]
Erforderliche Parameter urlpattern
sengine
Optionale Parameter format
limit (max:1000)
skip
date
keyword

Rückgabewerte url
Querschnittverbindungen getSearchEngines()
Hinweise Wird der Parameter Keyword gesetzt, übergibt die Funktion nur Unterseiten, die u.a. dieses Keyword enthalten. Wird kein Keyword gesetzt, werden alle Unterseiten zu der Domain übergeben.
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
sengine Enthält eine von Xovi gecrawlte Suchmaschine. siehe getSearchEngines()
keyword Enthält eine Bezeichnung für ein Keyword. (A-Z|a-z|0-9)+
date Enthält ein Datum nach ISO8601  Datum: YYYY-MM-DD Das Datum der Vorwoche
limit Legt fest, wie viele Ergebniszeilen zurückgegeben werden sollen. (max:1000) 0-1000 100
skip Legt fest, wie viele Zeilen des Ergebnisarrays übersprungen werden sollen. (0-9)+ 0
 format  Legt fest in welchem Format das Ergebnis zurückgeliefert werden soll. json|xml json

Rückgabewerte

Bezeichnung Beschreibung Wertebereich
url Enthält eine Unterseite der URL.  http[s]?://(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 die 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',
<%%KEEPWHITESPACE%%> 'method' =&gt;'getPages',
<%%KEEPWHITESPACE%%> 'key' =&gt;'yourPersonalKey',
<%%KEEPWHITESPACE%%> 'urlpattern' =&gt; 'www.xovi.de',
<%%KEEPWHITESPACE%%> 'sengine' =&gt; 'google.de',
<%%KEEPWHITESPACE%%> 'format' =&gt; 'json',
<%%KEEPWHITESPACE%%> 'limit' =&gt; '2',
<%%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;
?&gt;

Beispielergebnisse

JSON

{
 "apiErrorCode":"0",
 "apiErrorMessage":"0k.",
 "apiResult":[
           {"URL":"http:\/\/www.xovi.de\/"},
           {"URL":"http:\/\/www.xovi.de\/Bakclink-Toool\/"}]
 }

XML

<?xml version="1.0"?>
<result>
     <apiErrorCode>0</apiErrorCode>
     <apiErrorMessage>0k.</apiErrorMessage>
     <apiResult>
          <pages>
               <page>
                   <URL>http://www.xovi.de/</URL>
               </page>
               <page>
                   <URL>http://www.xovi.de/Backlink-Tool/</URL>
               </page>
          </pages>
      </apiResult>
</result>