|
|
Der Open Access Monitor stellt eine frei zugängliche [REST-API](https://open-access-monitor.de/api) bereit. Über diese API können alle öffentlichen Daten des Monitors abgefragt werden.
|
|
|
|
|
|
# Enpunkte
|
|
|
Die Endpunkte der API können [hier](https://open-access-monitor.de/api/swagger/) eingesehen werden.
|
|
|
# Datenabfrage
|
|
|
Zur Datenabfrage wird folgender Endpunkt benötigt:
|
|
|
|
|
|
`/data/{database}`
|
|
|
|
|
|
Als `database` kann aktuell nur "public" genutzt werden. Die Abfrage wird mittels `query` Parameter übergeben. Dieser nimmt [MongoDB-Commands](https://www.mongodb.com/docs/manual/reference/command/) an.
|
|
|
Folgende Commands werden von der API unterstützt:
|
|
|
* [find](https://www.mongodb.com/docs/manual/reference/command/find/)
|
|
|
* [aggregate](https://www.mongodb.com/docs/manual/reference/command/aggregate/)
|
|
|
* [count](https://www.mongodb.com/docs/manual/reference/command/count/)
|
|
|
* [distinct](https://www.mongodb.com/docs/manual/reference/command/distinct/)
|
|
|
* [getMore](https://www.mongodb.com/docs/manual/reference/command/getMore/)
|
|
|
* [mapReduce](https://www.mongodb.com/docs/manual/reference/command/mapReduce/)
|
|
|
* [listCollections](https://www.mongodb.com/docs/manual/reference/command/listCollections/)
|
|
|
|
|
|
Alle API Antworten sind entsprechend der zugehörigen MongoDB-Antwort formatiert.
|
|
|
|
|
|
Die Entitäten sind [hier](https://jugit.fz-juelich.de/synoa/oam-dokumentation/-/wikis/Open%20Access%20Monitor/Datenbankschema) beschrieben. Mögliche Collections zur Abfrage sind:
|
|
|
* Publications
|
|
|
* PublicationCosts
|
|
|
* Journals
|
|
|
* Publishers
|
|
|
* Organisations
|
|
|
|
|
|
Zusätzlich gibt es je Collection eine weitere mit dem Suffix `_old`, welche die Daten der Vorwoche enthält (Aktualisierung jeden Sonntag). Eine Liste aller Collections lässt sich mit folgendem Endpunkt angezeigt werden, wenn der `query` Parameter ausgelassen wird.
|
|
|
|
|
|
# Beispiele
|
|
|
OA-Kategorien werden innerhalb der Daten entsprechend der Tabelle im Abschnitt [OA-Kategorien](https://jugit.fz-juelich.de/synoa/oam-dokumentation/-/wikis/Open%20Access%20Monitor/OA%20Kategorien) als Zahl codiert.
|
|
|
|
|
|
<details><summary>Abfrage aller Publikationen aus 2020, welche Gold-Open-Access sind</summary>
|
|
|
# Beispiele
|
|
|
* Abfrage aller Publikationen aus 2020, welche Gold-Open-Access sind \
|
|
|
[https://open-access-monitor.de/api/Data/`public`?query=`{find:"Publications", filter:{year: 2018, oa_color: 7}}`](https://open-access-monitor.de/api/Data/public?query=%7Bfind%3A%22Publications%22%2C%20filter%3A%7Byear%3A%202018%2C%20oa_color%3A%207%7D%7D)
|
|
|
* Zeitschriften, welche in der DFG-Förderliste enthalten sind \
|
|
|
[https://open-access-monitor.de/api/Data/`public`?query=`{find:"Journals", filter:{flags: "DFG-Anträge"}}`](https://open-access-monitor.de/api/Data/public?query=%7Bfind%3A%22Journals%22%2C%20filter%3A%7Bflags%3A%20%22DFG-Antr%C3%A4ge%22%7D%7D)
|
|
|
* Anzahl Publikationen pro OA-Kategorie \
|
|
|
[https://open-access-monitor.de/api/Data/`public`?query=`{aggregate:"Publications", cursor:{}, pipeline:[{$group:{_id:"$oa_color", sum:{$sum: 1}}}]}`](https://open-access-monitor.de/api/Data/public?query=%7Baggregate%3A%22Publications%22%2C%20cursor%3A%7B%7D%2C%20pipeline%3A%5B%7B%24group%3A%7B_id%3A%22%24oa_color%22%2C%20sum%3A%7B%24sum%3A%201%7D%7D%7D%5D%7D)
|
|
|
|
|
|
```
|
|
|
https://open-access-monitor.de/api/Data/public?query={find:"Publications", filter:{year: 2018, oa_color: 7}}
|
|
|
```
|
|
|
</details>
|
|
|
<details><summary>Zeitschriften, welche in der DFG-Förderliste enthalten sind</summary>
|
|
|
# Swagger
|
|
|
|
|
|
```
|
|
|
https://open-access-monitor.de/api/Data/public?query={find:"Journals", filter:{flags: "DFG-Anträge"}}
|
|
|
```
|
|
|
</details>
|
|
|
Zur besseren Übersichtlichkeit bieten wir [Swagger](https://open-access-monitor.de/api/swagger) an. Dort können alle Endpunkte eingesehen werden sowie ausprobiert werden.
|
|
|
|
|
|
# Nutzungsbedingungen
|
|
|
Für die API gilt eine Fair Use Policy. Sollten wir eine überdurchschnittliche Auslastung feststellen, behalten wir uns vor entsprechende Maßnahmen zu ergreifen. Falls Sie umfangreichere Abfragen planen, sprechen Sie dies bitte vorher mit uns ab. |