API-Nutzung
Mithilfe des Themenbereichs „API-Nutzung“ kann der Design-Analytics-Benutzer Berichte und Dashboards erstellen. Im Folgenden finden Sie Beispiele für Geschäftsfragen, die mithilfe des Themenbereichs „API-Nutzung“ beantwortet werden können:
- Wie viele APIs vom Typ x wurden im vergangenen Jahr ausgeführt?
- Welches sind die 10 am häufigsten verwendeten APIs, geordnet nach API-Namen?
- Welche Arten von APIs wurden in den letzten 3 Jahren nach Monaten verwendet?
- Welche APIs wurden nach Modulen verwendet?
Feldbeschreibungen
Im Folgenden sind die in der API-Nutzung verfügbaren Felder aufgeführt.
API-Kennzahlen
Die Tabelle „API-Kennzahlen“ ist eine Faktentabelle, in der alle Kennzahlen zur API-Nutzung gespeichert werden.
| Feld | Beschreibung | Zusätzliche Informationen | Datentyp | Datengröße |
|---|---|---|---|---|
| API-Nutzung - Erwerbung | API-Nutzung für Erwerbungen. | DOUBLE | ||
| API-Nutzung - Analytics | API-Nutzung für Analytics. | DOUBLE | ||
| API-Nutzung - Titeldaten | API-Nutzung für Titeldaten. | DOUBLE | ||
| API-Nutzung - Konfigurationen | API-Nutzung für Konfigurationen. | DOUBLE | ||
| API-Nutzung - Kurse | API-Nutzung für Kurse. | DOUBLE | ||
| API-Nutzung - Elektronik | API-Nutzung für Elektronikprodukte. | DOUBLE | ||
| API-Nutzung - Physical Items | API-Nutzung für physische Titel. | DOUBLE | ||
| API-Nutzung - Fernleihpartner | API-Nutzung für Fernleihpartner. | DOUBLE | ||
| API-Nutzung - Aufgabenliste | API-Nutzung für die Aufgabenliste. | DOUBLE | ||
| API-Nutzung - Benutzer | API-Nutzung für Benutzer. | DOUBLE | ||
| API-Nutzung - Sonstiges | API-Nutzung für andere Bereiche. | DOUBLE | ||
| API-Verwendung - Gesamt | Gesamte API-Nutzung. | DOUBLE |
API-Details
Die Tabelle „API-Details“ ist eine Dimensionstabelle, in der Informationen zur API-Nutzung gespeichert werden.
| Feld | Beschreibung | Zusätzliche Informationen | Datentyp | Datengröße |
|---|---|---|---|---|
| API-Bereich | Der API-Bereich, zum Beispiel Erwerbung. | VARCHAR | 50 | |
| Anwendungsname | Der dem API-Schlüssel zugewiesene Name. | VARCHAR | 500 | |
| Anwendungsschlüssel | Die letzten vier Ziffern des API-Schlüssels. | VARCHAR | 5 | |
| API-Methode | Die API-Methode. | Mögliche Werte: GET, POST, PUT und DELETE | VARCHAR | 50 |
| API-URL | Der Pfad der jeweiligen API, zum Beispiel: /almaws/v1/acq/funds | VARCHAR | 4000 | |
| Produkt | Das Produkt. | Mögliche Werte: Alma und Primo | VARCHAR | 20 |
API-Datumsangaben
Die Tabelle „API-Daten“ ist eine Dimensionstabelle, in der Details zu den Daten der API-Nutzung gespeichert werden.
| Feld | Beschreibung | Zusätzliche Informationen | Datentyp | Datengröße |
|---|---|---|---|---|
| Datum der Ausführung | Das Datum, an dem die API ausgeführt wurde. | Das Datum im Format TT/MM/JJJJ | DATUM | |
| Filter nach Ausführungsdatum | Wird verwendet, um die Berichtsergebnisse nach Datum zu filtern. |
Mögliche Werte:
|
VARCHAR | 100 |
| Ausführungsquartal | Das Quartal des Jahres, in dem die API ausgeführt wurde. | Das Quartal des Datums in einem Anzeigeformat wie Q1 | VARCHAR | 20 |
| Jahr der Ausführung | Das Jahr, in dem die API ausgeführt wurde. | Das Jahr des Datums im Format JJJJ. Zum Beispiel - 2025 | VARCHAR | 20 |
| Geschäftsjahr der Ausführung | Das Geschäftsjahr, in dem die API ausgeführt wurde. | Das Jahr wird gemäß der Beschreibung in der Zuordnungstabelle „Etat- und Konto-Abrechnungszeitraum“ dargestellt. Für weitere Informationen siehe Konfiguration der Etat- und Konto-Abrechnungszeiträume. | VARCHAR | 50 |
| Monat der Ausführung | Der Monat, in dem die API ausgeführt wurde. | Der Monat, zum Beispiel „Februar“ | VARCHAR | 20 |
| Schlüssel für den Ausführungsmonat | Der Monat des Ausführungsdatums im Zahlenformat. | Zum Beispiel wird in dieser Spalte für Februar die Zahl 2 angezeigt. Dieses Feld ist nützlich, wenn Sie nach Monaten sortieren möchten. | INT | |
| Geschäftsmonat der Ausführung | Der Geschäftsmonat, in dem die API ausgeführt wurde. | Der Geschäftsmonat des Datums im Format der Monatsbezeichnung, zum Beispiel Februar. | INT | |
| Ausführungsmonat (vollständig) | Das Jahr und der Monat, in denen die API ausgeführt wurde. | Der Monat im Textformat und das Jahr. Zum Beispiel - Feb 25 (für Februar 2025) | VARCHAR | 20 |
| Ausführungsbeginn der Woche | Das Datum des ersten Werktags der Woche. | Das Datum im Format TT/MM/JJJJ | DATUM | |
| Nummer der Ausführungswoche | Die Nummer der Kalenderwoche. | Ein Jahr hat 52 Wochen. | VARCHAR | 2 |
| Jahr und Monat der Ausführung | Das Jahr und der Monat, in denen die API ausgeführt wurde. | Das Jahr und der Monat im Format JJJJ-MM | VARCHAR | 250 |
| Ausführungsdatum | Das Ausführungsdatum in einem hierarchischen Format. | Ermöglicht es dem Benutzer, vom Jahr über den Monat bis hin zum spezifischen Datum tiefer in die Daten einzutauchen. Mit dieser Spalte hat der Benutzer die Möglichkeit, die kumulativen Kennzahlen auf jeder Ebene der Hierarchie anzuzeigen. |
In Institution
Dank der gemeinsamen Dimensionskategorie „Institution“ kann die Network Zone Berichte nach Institutionen anzeigen. Wird ein Analytics-Bericht aus der Network Zone in einem gemeinsamen Netzwerk ausgeführt, das eine Network Zone implementiert, werden alle Mitgliedsinstitutionen im Bericht unter „Institutionscode“ und „Institutionsname“ aufgeführt. Wird ein Analytics-Bericht von einer Institution erstellt, die nicht zu einem gemeinsamen Netzwerk mit einer Network Zone gehört, werden im Bericht unter „Institutionscode“ und „Institutionsname“ nur die Angaben derjenigen Institution aufgeführt, von der aus der Bericht erstellt wurde.
Diese Dimension ist in jedem Themenbereich verfügbar. Es enthält die folgenden Felder:
| Feld | Beschreibung | Zusätzliche Informationen | Datentyp | Datengröße |
|---|---|---|---|---|
| Institutionscode | Der Code der Institution. |
Konfiguriert über: Konfiguration > Allgemein > Eine Bibliothek hinzufügen oder Bibliotheksinformationen bearbeiten > Registerkarte Zusammenfassung. Die Bezeichnung in Alma lautet Code und befindet sich im rechten Bereich. |
VARCHAR | 50 |
| Institutionsname | Der Name der Institution. |
Konfiguriert über: Konfiguration > Allgemein > Eine Bibliothek hinzufügen oder Bibliotheksinformationen bearbeiten > Registerkarte Zusammenfassung. Die Bezeichnung in Alma lautet Name der Organisationseinheit. |
VARCHAR | 255 |
| Institution - Adresszeile 1 | Die erste Zeile der Adresse der Institution. Sie enthält in der Regel die Hausnummer und den Straßennamen. |
Konfiguriert über: Konfiguration > Allgemein > Eine Bibliothek hinzufügen oder Bibliotheksinformationen bearbeiten > Registerkarte Kontaktinformation. Diese Angabe stammt aus der Adresse, die als bevorzugte Adresse konfiguriert ist. Die Bezeichnung in Alma lautet „Adresszeile 1“. |
VARCHAR | 1000 |
| Institution - Ort | Die Stadt, in der sich die Institution befindet. |
Konfiguriert über: Konfiguration > Allgemein > Eine Bibliothek hinzufügen oder Bibliotheksinformationen bearbeiten > Registerkarte Kontaktinformation. Diese Angabe stammt aus der Adresse, die als bevorzugte Adresse konfiguriert ist. Die Bezeichnung in Alma lautet „Stadt“. |
VARCHAR | 255 |
| Institution - Bundesland | Das Bundesland oder die Provinz der Institution. |
Konfiguriert über: Konfiguration > Allgemein > Eine Bibliothek hinzufügen oder Bibliotheksinformationen bearbeiten > Registerkarte Kontaktinformation. Diese Angabe stammt aus der Adresse, die als bevorzugte Adresse konfiguriert ist. Die Bezeichnung in Alma lautet „Bundesland/Provinz“. |
VARCHAR | 320 |
| Institutionsland | Das Land der Institution. |
Konfiguriert über: Konfiguration > Allgemein > Eine Bibliothek hinzufügen oder Bibliotheksinformationen bearbeiten > Registerkarte Kontaktinformation. Diese Angabe stammt aus der Adresse, die als bevorzugte Adresse konfiguriert ist. Die Bezeichnung in Alma lautet „Land“. |
VARCHAR | 320 |
| Institution - Postleitzahl | Die Postleitzahl der Institution. |
Konfiguriert über: Konfiguration > Allgemein > Eine Bibliothek hinzufügen oder Bibliotheksinformationen bearbeiten > Registerkarte Kontaktinformation. Diese Angabe stammt aus der Adresse, die als Bevorzugte Adresse konfiguriert ist. Die Bezeichnung in Alma lautet Postleitzahl. |
VARCHAR | 200 |
| Institution - Zeitzone | Die Zeitzone der Institution. | Die Zeitzone wird während der Implementierung festgelegt. | VARCHAR | 255 |
| Daten verfügbar ab | Wann die Daten der Institution in Analytics verfügbar wurden. | Wird unten im Hauptmenü von Analytics angezeigt. | VARCHAR | 255 |
| Datum geändert ab | Wann die Daten der Institution aus der Alma-Datenbank entnommen wurden. | Wird unten im Hauptmenü von Analytics angezeigt. | VARCHAR | 255 |
Seiten-Tags: article:topic product:alma content:Documentation lang:english