getDownloads

Gibt eine Übersicht über alle downloadbaren, bereits erstellten Reports zurück.

Route /report/getDownloads[/:key[/:format[/:limit[/:skip]]]]
Erforderliche Parameter
Optionale Parameter format
limit (max:1000)
skip
Rückgabewerte id
domain
sengine
reportDate
Querschnittverbindungen  
Hinweise Limit: Das maximale Limit ist 1000. Um mehr Ergebnisse zu erhalten, benutzen Sie den Parameter Skip.

Übergabeparameter

Bezeichnung Beschreibung Wertebereich Standardwert
format Legt fest in welchem Format das Ergebnis zurückgeliefert werden soll. json|xml json
limit Legt fest, wie viele Ergebniszeilen zurückgegeben werden sollen. (0-9)+ 10
skip Legt fest, wie viele Seiten des Ergebnisarrays übersprungen werden sollen. Eine Seite entspricht dem Wert von limit. (0-9)+ 0

Rückgabewerte

Bezeichnung Beschreibung Wertebereich
id Enthält einen eindeutigen Bezeichner für einen bereits erstellten und downloadbaren Report. (0-9)+
domain Enthält einen qualifizierten Domainnamen. (www.)?(A-Z|a-z|0-9)+. (a-z)+
sengine Enthält den Namen der Suchmaschine. (www.)?(A-Z|a-z|0-9)+. (a-z)+
reportDate Enthält das Datum der Datenbasis. Datum: YYYY-MM-DD

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' => 'report',
 'method' => 'getDownloads',
'key' => 'myPersonalKey',
 'format' =>'xml',
 'limit' => '20',
 'skip' => '2',
 );
$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":[
     {
         "id":"22560",
         "domain":"xovi.de",
         "sengine":"google.ch",
         "reportDate":"2012-10-07",
     }]
}

XML

<?xml version="1.0"?>
<result>
    <apiErrorCode>0</apiErrorCode>
    <apiErrorMessage>0k.</apiErrorMessage>
    <apiResult>
        <downloads>
            <download>
                <id>22560</id>
                <domain>xovi.de</domain>
                <sengine>google.ch</sengine>
                <reportDate>2012-10-07</reportDate>
            </download>
        </downloads>
    </apiResult>
</result>