getKeywordLimits
Gibt die Verbrauchsgrenzen der Monitoring Keywords zurück. (Enthält für andere Funktionen relevante Daten.)
Route |
/monitor/getKeywordLimits[/:key[/:format]] |
Erforderliche Parameter |
– |
Optionale Parameter |
format
|
Rückgabewerte |
total
used |
Querschnittverbindungen |
– |
Hinweise |
– |
Parameter
Bezeichnung |
Beschreibung |
Wertebereich |
Standartwert |
format |
Legt fest in welchem Format das Ergebnis zurückgeliefert werden soll. |
json|xml |
json |
Rückgabewerte
Bezeichnung |
Beschreibung |
Wertebereich |
total |
Enthält die maximale Anzahl der Credits im Monitoringbereich. |
(0-9)+ |
used |
Enthält die Anzahl der verbrauchten Credits im Monitoringbereich. |
(0-9)+ |
Meldungen
Nachricht |
Beschreibung |
no permission |
Der Api-Key hat keine Berechtigung diese Funktion aufzurufen. |
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' => 'getMonitoringKeywordLimits',
'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":[{
"total":5000,
"used":264
}]
}
XML
<?xml version="1.0"?>
<result>
<apiErrorCode>0</apiErrorCode>
<apiErrorMessage>0k.</apiErrorMessage>
<apiResult>
<limits>
<limit>
<total>5000</total>
<used>264</used>
</limit>
</limits>
</apiResult>
</result>