getMonitoringOviTrend

Gibt den Monitoring OVI-Verlauf einer Projektdomain zurück.

Route /keywords/getMonitoringOviTrend[/:key[/:projhash[/:format[/:limit[/:skip[/:device[/:sengineid[/:labelid[/:date[/:competitor]]]]]]]]]]
Erforderliche Parameter projhash
Optionale Parameter format
limit (max:1000)

skip
device
sengineid
labelid
date
competitor
Rückgabewerte date
value
Querschnittverbindungen getProjects() – Diese Funktion enthält die Projekt Hashes.
getSearchengines() – Diese Funktion enthält die Searchengine Ids.
getLabels() – Diese Funktion enthält die Label Ids.
Hinweise date – Gibt es zu dem übergebenen Startdatum keinen Ovi, wird das letzte gültige Datum gewählt.
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
projhash Enthält ein Hash eines angelegten Projektes md5-String
siehe getProjects()
device Enthält eine device Id. 1 – PC
2 – Tablet
3 – Handy
1
limit Legt fest, wie viele Ergebniszeilen zurückgegeben werden sollen. (max:1000) 0-1000 100
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 eine Searchengine Id. siehe getSearchengines() NULL (Alle)
labelid Enthält ein Label Hash. siehe getLabels() NULL (Alle)
date Enthält eine Startdatum. Y-m-d letztes gültiges Datum
competitor Hash eines Mitbewerbers des Projektes. (Wird ein gültiger Mitbewerber-Hash übergeben, wird der Ovitrend zu diesem zurückgegeben.) string NULL

Rückgabewerte

Bezeichnung Beschreibung Wertebereich
date Zeigt das Datum an, an dem der dazugehörende Monitoring OVI gemessen wurde Datum: YYYY-MM-DD
value Enthält den Monitoring OVI einer Projektdomain zu einem bestimmten Zeitpunkt. (0-9)+.(0-9)+

Meldungen

Nachricht Beschreibung
maximum limit exeeded Das maximale Limit wurde überschritten.
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'  =>'getMonitoringOviTrend',
                     'key'     =>'myPersonalKey',
                     'projhash' => 'myProjectHash',
		  );
$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":[
        {
            "date":"2013-02-11",
            "value":5995.01
        },
        {
            "date":"2013-02-18",
            "value":5859.46
        },
        {
            "date":"2013-02-25",
            "value":5626.82
        }]
}

XML

<?xml version="1.0"?>
<result>
    <apiErrorCode>0</apiErrorCode>
    <apiErrorMessage>0k.</apiErrorMessage>
    <apiResult>
        <monitoringOvis>
            <monitoringOvi>
                <date>2013-02-18</date>
                <value>97.67</value>
            </monitoringOvi>
            <monitoringOvi>
                <date>2013-02-25</date>
                <value>93.36</value>
            </monitoringOvi>
            <monitoringOvi>
                <date>2013-03-04</date>
                <value>91.98</value>
            </monitoringOvi>
        </monitoringOvis>
    </apiResult>
</result>