API-Dashboard
Inhaltsverzeichnis
Das neue API-Dashboard verfügt über eine völlig neue Oberfläche zur Anzeige Ihrer Nutzungsstatistiken. Die Oberfläche besteht aus einer Diagrammansicht und einer Tabellenansicht. Sie können die Statistiken nach Modulen, IP-Adresse, von der aus der Aufruf erfolgt ist, Methode, Benutzer oder Zeit klassifizieren. Dieses Dashboard unterstützt sowohl die vorherige Version der API als auch die neue Version.
Die neue API-Nutzungsstatistik:
- Der Fortschrittsbalken bleibt violett, bis 90 % der API-Aufrufe erfolgt sind. Danach wird er rot.
- Die neue API folgt der Methode "Tracking der letzten 24 Stunden", was eine organisatorische Zeitzone ist.
- Die Aktualisierung der API-Aufrufe erfolgt auf der Grundlage der Zeitzone. Mit anderen Worten: Wenn 50 Aufrufe zwischen 14 und 15 Uhr getätigt werden, können diese 50 Aufrufe am nächsten Tag nur zur selben Zeit getätigt werden.
Hinweis:
- Die Tracking-Methode der letzten 24 Stunden steht nur in der neuen API-Version 2 zur Verfügung.
- Es gäbe eine Verzögerung von 15 Minuten bei der Aktualisierung der Statistiken. Die Anzahl der verwendeten API-Aufrufe wird jedoch sofort aktualisiert.
- Statistiken über API-Nutzung, die mehr als 30 Tage alt sind, werden regelmäßig gelöscht.
Die alte API-Nutzungsstatistik:
- Die alte API verwendet bei der Berechnung die PDT-Zeitzone.
Verfügbarkeit
Das V2-Dashboard
Die Nutzungsstatistiken helfen Ihnen, die Anzahl der API-Aufrufe zu verfolgen, die Sie getätigt haben, um zu planen, wie Sie das CRM am effektivsten nutzen können. Die Statistik für die API-Version 2 (neu) wird folgendermaßen klassifiziert.
Anwendungsbezogen:
Die neue API basiert auf API-Aufrufen aus bestimmten Anwendungen. Daher wäre die Klassifizierung nach der Anwendung, aus der der Aufruf erfolgte, sinnvoller als eine Klassifizierung nach API-Aufruf.
Diagrammansicht:
Ein Kreisdiagramm wird verwendet, um die Top-5-Anwendungen darzustellen, für die APIs aufgerufen wurden.
Klicken Sie auf das Symbol Listenansicht, um die 5 am häufigsten verwendeten Anwendungen im Listenformat anzuzeigen.
Hinweis:
- Klicken Sie auf einen der Anwendungsnamen, um die Statistiken für diese Anwendung in der Tabellenansicht zu öffnen.
Tabellenansicht:
Die Spalte "Anwendungen" ist als Standardspalte festgelegt, und der Rest der Informationen ist entsprechend angeordnet.
Modulbasiert:
Sie können Nutzungsstatistiken anzeigen, die auf API-Aufrufen aus Modulen basieren.
Diagrammansicht:
In der Diagrammansicht werden nur die wichtigsten 5 Module angezeigt. Klicken Sie auf einen beliebigen Modulnamen, um die Statistiken in der Tabellenansicht mit der Standardspalte "Modul" zu öffnen.
Hinweis:
- Klicken Sie auf die Schaltfläche Listenansicht, um die 5 wichtigsten Methoden, aus denen die API-Aufrufe stammen, als Liste anzuzeigen.
- Klicken Sie auf Alle anzeigen, um die Statistiken aller Module anzuzeigen.
Tabellenansicht:
Die Tabellenansicht ist noch präziser, da sie alle Informationen zum Modul auf einen Blick anzeigt.
Hinweis:
- Klicken Sie auf "Sortierreihenfolge", um die Tabelle in der gewünschten Ansicht zu sortieren.
- Bewegen Sie den Mauszeiger über die Informationen, und Sie können die Verbindung zwischen den Datensätzen sehen.
IP-adressbasiert:
Listenansicht:
Sie können die Statistiken basierend auf der IP-Adresse des Benutzers in der Diagrammansicht finden. Mit anderen Worten: Die Statistiken werden basierend auf den Zugriffspunkten der Benutzer angezeigt. Es werden nur die wichtigsten 5 IP Adressen mit den meisten API-Aufrufen angezeigt. Um alle Benutzer-IP-Adressen anzuzeigen, klicken Sie auf Alle anzeigen.
Hinweis:
- Klicken Sie auf eine der IP-Adressen, um die Tabellenansicht mit der IP-Adresse als Standardspalte zu öffnen.
Tabellenansicht:
In der Tabellenansicht ist die Spalte "IP-Adresse" als Standard eingestellt, und der Rest der Informationen wird darauf basierend angeordnet.
Benutzerbasiert:
Sie können die Verwendung basierend darauf, wer die API-Aufrufe gemacht hat, im Abschnitt "Produktive Benutzer" einsehen.
Diagrammansicht:
Die wichtigsten 3 Benutzer, welche die meisten API-Aufrufe gemacht haben, sind in diesem Abschnitt aufgeführt.
Hinweis:
- Klicken Sie auf Alle anzeigen, um die Anzahl der API-Aufrufe aller Benutzer anzuzeigen.
Tabellenansicht:
Die IP-Adresse, das Verfahren und das von einem Benutzer verwendete Modul können angezeigt werden, indem die Spalte "Benutzer" als Standardspalte in der Tabellenansicht festgelegt wird.
Zeitabhängig:
Eine der einfachsten Möglichkeiten, Ihre Nutzung und Grenzwerte zu kennen, ist die Berücksichtigung der Zeit, in der die API-Aufrufe erfolgen. Dies ist nur in der Diagrammansicht verfügbar.
Das Diagramm mit den Statistiken für einen einzelnen Tag:
Das Diagramm mit den Statistiken für einen Datumsbereich:
Das V1-Dashboard
Die Nutzungsstatistiken helfen Ihnen, die Anzahl der API-Aufrufe zu verfolgen, die Sie getätigt haben, um zu planen, wie Sie das CRM am effektivsten nutzen können. Die Statistik für die V1-API (alt) wird folgendermaßen klassifiziert.
Methodenbasiert:
Sie können die Statistiken auch aus der Perspektive anzeigen, mit welcher API-Methode die API aufgerufen wurde.
Diagrammansicht:
Ein Kreisdiagramm wird verwendet, um die 5 am häufigsten verwendeten API-Methoden darzustellen.
Hinweis:
- Klicken Sie auf einen der Anwendungsnamen, um die Statistiken für diese Anwendung in der Tabellenansicht zu öffnen.
Tabellenansicht:
Die Spalte "Anwendungen" ist als Standardspalte festgelegt, und der Rest der Informationen ist entsprechend angeordnet.
Modulbasiert:
Sie können Nutzungsstatistiken anzeigen, die auf API-Aufrufen aus Modulen basieren.
Diagrammansicht:
In der Diagrammansicht werden nur die wichtigsten 5 Module angezeigt. Klicken Sie auf einen beliebigen Modulnamen, um die Statistiken in der Tabellenansicht mit der Standardspalte "Modul" zu öffnen.
Hinweis:
- Klicken Sie auf die Schaltfläche Listenansicht, um die 5 wichtigsten Methoden, aus denen die API-Aufrufe stammen, als Liste anzuzeigen.
- Klicken Sie auf Alle anzeigen, um die Statistiken aller Module anzuzeigen.
Tabellenansicht:
Die Tabellenansicht ist noch präziser, da sie alle Informationen zum Modul auf einen Blick anzeigt.
Hinweis:
- Klicken Sie auf "Sortierreihenfolge", um die Tabelle in der gewünschten Ansicht zu sortieren.
- Bewegen Sie den Mauszeiger über die Informationen, und Sie können die Verbindung zwischen den Datensätzen sehen.
IP-adressbasiert:
Diagrammansicht:
Dies wird auch als zugriffspunktbasiert bezeichnet. Sie können die Statistiken basierend auf der IP-Adresse des Benutzers suchen. Es werden nur die wichtigsten 5 IP Adressen mit den meisten API-Aufrufen angezeigt. Um alle Benutzer-IP-Adressen anzuzeigen, klicken Sie auf Alle anzeigen.
Hinweis:
- Klicken Sie auf eine der IP-Adressen, um die Tabellenansicht mit der IP-Adresse als Standardspalte zu öffnen.
Tabellenansicht:
In der Tabellenansicht ist die Spalte "IP-Adresse" als Standard eingestellt, und der Rest der Informationen wird darauf basierend angeordnet.
Benutzerbasiert:
Sie können die Verwendung basierend darauf, wer die API-Aufrufe gemacht hat, im Abschnitt "Produktive Benutzer" einsehen.
Diagrammansicht:
Die wichtigsten 3 Benutzer, welche die meisten API-Aufrufe gemacht haben, sind in diesem Abschnitt aufgeführt.
Hinweis:
- Klicken Sie auf Alle anzeigen, um die Anzahl der API-Aufrufe aller Benutzer anzuzeigen.
Tabellenansicht:
Die IP-Adresse, das Verfahren und das von einem Benutzer verwendete Modul können angezeigt werden, indem die Spalte "Benutzer" als Standardspalte in der Tabellenansicht festgelegt wird.
Zeitabhängig:
Eine der einfachsten Möglichkeiten, Ihre Nutzung und Grenzwerte zu kennen, ist die Berücksichtigung der Zeit, in der die API-Aufrufe erfolgen. Dies ist nur in der Diagrammansicht verfügbar.
Das Diagramm mit den Statistiken für einen einzelnen Tag:
Das Diagramm mit den Statistiken für einen Datumsbereich: