Dokumentation


Die Cronimon-API basiert auf HTTP und kann von beliebigen Applikationen, Programmiersprachen, Betriebssystemen Web-Browsern angesprochen werden. Sie verwenden die API, um Zustands- oder Ereignisinformationen an Cronimon zu senden. Hierzu können Sie unsere Codeschnipsel oder Sprachbibliotheken nutzen.


Einen Datenpunkt hinzufügen

(Falls notwendig wird implizit eine Datenserie mit dem übergebenen name Parameter erzeugt)

Erstellen Sie Ihr eigenes SmartChart
http://[IHRE USER ID].put.cronimon.com/?name=[NAME IHRER DATENSERIE]&value=[DATENWERT]&time=[UNIX-TIMESTAMP]              

Der name Parameter wird benötigt um einen Datenpunkt hinzuzufügen. Er wird benutzt um die zugehörige Datenserie zu identifizieren.
Value kann eine beliebige Fließkommazahl sein. Dies ist der Wert, den Sie überwachen möchten - z.B. der Preis eines Produktes, das Sie gerade verkauft haben. Falls value nicht übermittelt wird ist der Standard-Wert "1".
Der user_id Paramter wird benötigt, um den Datenpunkt Ihrem Cronimon Account zuzuordnen.
Der time Parameter ist ein Unix-Timestamp in Sekunden. Falls time nicht übermittelt wird, wird für den Datenpunkt die aktuelle Cronimon Serverzeit verwendet.


Sie können mehrere Datenpunkte in einem einzelnen HTTP-Request übermitteln:

http://[IHRE USER ID].put.cronimon.com/?name[]=[NAMEN DER DATENSERIEN]&value[]=[DATENWERTE]&time[]=[UNIX-TIMESTAMPS]            

Die Parameter name[], value[] und time[] sind verpflichtend. Alle Arrays müssen die gleiche Größe haben und die Daten in der richtigen Reihenfolge übermittelt werden. Der erste Werte des name-Arrays wird dabei dem ersten Wert des value-Arrays und dem ersten Wert des time-Arrays zugeordnet und so weiter. Sie können in einem Aufruf bis zu 100 Datenpunkte übermitteln. Wenn Sie mehrere Datenpunkte übermitteln erhalten Sie für jeden Datenpunkt einen API-Rückgabewert (es sei denn ein Fehler betrifft den kompletten API-Aufruf).

Example: http://xyz.put.cronimon.com/?name[]=first_name&value[]=1&name[]=second_name&value[]=2


Rückgabewerte:

 1   : Datenpunkt erfolgreich hinzugefügt 
-1   : Kein Name übergeben 
-2   : Ungültiger Datenwert 
-3   : Keine USER-ID übergeben 
-5   : Ungültiger Name übergeben 
-6   : Anzahl der Parameter stimmt nicht überein (Die Arrays "names", "values" und "times" müssen die gleiche Größe haben)
-7   : Maximale Anzahl Datenpunkte überschritten (Aktuell können pro HTTP-Request bis zu 100 Datenpunkte übergeben werden) 
-8   : Maximale Anzahl Datenpunkte pro Tag überschritten 
-9   : Maximale Anzahl Datenserien überschritten, 
-10  : Ungültiger Benutzer 
-11  : Maximale Anzahl Datenpunkte pro Tag überschritten 
-127 : Socket timeout            



SmartCharts können auf verschiedene Arten verwendet werden:

  • Als Embed-Objekt auf einer Webseite
  • Dynamisch erzeugte Charts, mit Hilfe von Datenseriennamen und Chart Eigenschaften
  • In einem Cronimon Dashboard


Ein SmartChart auf einer Webseite einbetten

Jedes SmartChart besitzt einen Embed-Code, über den es auf beliebigen Webseiten eingebettet werden kann. Sie finden diesen in Ihrer Chart-Liste (Menu --> My SmartCharts):


oder in der Menüleiste Ihres Charts:

.


Charts auf anderen Webseiten einzubetten ist hilfreich, wenn Sie diese anderen Benutzern präsentieren möchten oder wenn Sie bereits existierende Lösungen erweitern wollen (z.b. Admin Panels, Statistikseiten, ...).
Aus Gründen der Datensicherheit werden in eingebetteten Charts nur öffentliche Datenserien angezeigt.


Dynamische SmartCharts

In manchen Fällen möchten Sie ein Chart nicht manuell erstellen sondern on the fly generieren, indem Sie die Namen der Datenserien und die Chart-Eigenschaften als Parameter an ein Embed-Objekt übergeben. Das ist beispielsweise hilfreich, wenn Sie für verschiedene Benutzer Datenserien speichern (user_info_1, user_info_2, ...) und dem jeweiligen Benutzer seine Datenserien anzeigen möchten.

Dynamische Charts können erzeugt werden, indem Sie dem embed-Code des Charts das JSON-Objekt externalSettings hinzufügen.


Beispiel:

    <object width="520" height="390" type="application/x-shockwave-flash" id="_cw" 
            data="http://widgets.cronimon.com/CronimonWidget.swf">
      <param name="wmode" value="opaque" />
      <param name="movie" value="http://widgets.cronimon.com//CronimonWidget.swf" />
      <param name="allowFullScreen" value="true" />
      <param name="allowscriptaccess" value="always" />
      <param name="flashvars" value="externalSettings={
                                            'userId' : 'MyCronimonUserId', 
                                            'title' : 'Example Chart', 
                                            'description' : 'This is a dynamic Chart', 
                                            'chartSettings' : { 
                                               'series' : ['Example_1','Example_2'] 
                                            }
                                        }&server_url=widgets.cronimon.com/&host=http://" />
      <embed width="520" height="390" flashvars="
                                        externalSettings={
                                            'userId' : 'MyCronimonUserId', 
                                            'title' : 'Example Chart', 
                                            'description' : 'This is a dynamic Chart', 
                                            chartSettings' : { 
                                              'series' : ['Example_1','Example_2'] 
                                            }    
                                        }&server_url=widgets.cronimon.com/&host=http://" 
             wmode="opaque" allowscriptaccess="always" id="_cw" src="http://widgets.cronimon.com//CronimonWidget.swf" />
    </object>
  


Das externalSettings Objekt unterstützt die folgenden Attribute:

externalSettings = {
  'title'         : 'ChartTitle',
  'titleBgColor'  : '0xffffff',
  'titleColor'    : '0x000000',
  'titleFontSize' : '18',
  
  'description'   : 'A Chart Description',

  'chartType'     : 1,                                        // 1: Line Chart, 2: Bar Chart, 3: Pie Chart
  
  'bgColor'       : '0xffffff',                               // chart background color
  
  'chartSettings' : {
    
    'series'                  : ['Series1','Series2', ...],   // Array of the data series names to display
    'timeLevel'               : 'current',                    // Pre selected time level 
                                                              // (current, minutes, hours, days, weeks, months)
                                                              
    'aggType'                 : 'avg',                        // Pre selected aggregation type (avg, count, sum, min, max)
    
    'seriesWeight'            : '1.5', 
    'seriesRadius'            : '2',                          // Size of data points
    'seriesForm'              : 'curve',                      // segment, curve, horizontal, reverseStep, step, vertical 
    'columnType'              : 'stacked',                    // Bar Charts only, 
                                                              // possible values: "stacked", "overlaid", "100percent"

    'lineColors'              : [                             // The line colors are applied to the respective data-series
        "0xff0000","0x00ff00","0x0000ff",                     // in the 'series' array
        "0xFAFA1B","0xFF8000","0xaa00aa",
        "0x870000","0x048200","0x000969"
    ],       
   
    
    'showAggregationControls' : 'true',
    'showTimelevelControls'   : 'true',
    
    'showLegend'              : 'true',
    'legendIconSize'          : '7',
    'legendFontSize'          : '10',
    'legendFontColor'         : '0x999999',
    'legendBorderColor'       : '0xEEEEEE',
    'legendDisabledColor'     : '0x888888',  
    
    'dataTipBackgroundColor'  : '0xffffff',
    'dataTipFontColor'        : '0x000000',
    'dataTipBorderWeight'     : '1.5',
    'dataTipBackgroundAlpha'  : '0.7',
    'dataTipWidth'            : '145',
    'dataTipHeight'           : '40',
    'dataTipRounding'         : '9'    
  }
}
  


Bitte achten Sie darauf, dass dynamisch erzeugte Charts nur auf der Seite exsitieren, wo sie eingebettet wurden. Dynamisch erzeugte Charts sind nicht in der Liste Ihrer Charts innerhalb des Cronimon Loginbereichs verfügbar.


Ein SmartChart zu einem Cronimon Dashboard hinzufügen

Sie können einem Cronimon Dashboard eine beliebige Anzahl SmartCharts hinzufügen, in dem sie auf den "Add Chart" Knopf klicken und das gewünschte Chart auswählen. Dashboards bieten eine komfortable Möglichkeit, Ihre Charts zu organisieren und Informationen zu einem bestimmten Thema in Views und Tabs zu strukturieren.