API
Journals Monitor (OAM-CH) offers an Open REST API, which is available at REST-API. All public data of the Journal Monitor (OAM-CH) can be queried.
Data query
This end point is required for data query:
/data/{database}
So far only “public” can be used as database. The query is passed by query parameter. The following MongoDB-Commands are supported by the API:
All API answers are formatted according to the answers of the MongoDB. The entities are described here . Possible collections for queries:
- Publications
- Journals
- Publishers
- Organisations
The previous week’s data is stored in additional collections with the suffix _old, which are updated every Sunday. With this endpoint and without a query parameter a list of all collections can be obtained.
The Open Access types are encoded as numbers as shown in this table: OA typology
Queries used for the charts on this website
The following data queries were used for the basic charts visible on the Journal Monitor (OAM-CH) webpage:
- National level, published between 2020-2024: https://oam.oamonitor.ch/api/data/public?query={“aggregate”: “Publications”,”cursor”: {“batchSize”: 1000},”allowDiskUse”: true,”pipeline”: [{“$match”: {“published_date.year”: {“$gte”: 2020,”$lte”: 2024}}},{“$group”: {“_id”: {“oa_type”: “$oa_color”,”year”: “$published_date.year”},”count”: {“$sum”: 1}}}]}
- By institution category, published between 2020-2024: https://oam.oamonitor.ch/api/data/public?query={“aggregate”: “Publications”,”cursor”: {“batchSize”: 1000},”allowDiskUse”: true,”pipeline”: [{“$match”: {“published_date.year”: {“$gte”: 2020,”$lte”: 2024}}},{“$unwind”: “$organisations”},{“$group”: {“_id”: {“type”: “$organisations.type”,”oa_type”: “$oa_color”,”year”: “$published_date.year”},”distinct”: {“$addToSet”: “$_id”}}},{“$project”: {“count”: {“$size”: “$distinct”}}}]}
Examples for other queries
- All Gold-OA publications from 2020 https://oam.oamonitor.ch/api/data/public?query={“find”: “Publications”,”filter”: {“published_date.year”: 2020,”oa_color”: 7}}
- All Green-OA publications from 2021 https://oam.oamonitor.ch/api/data/public?query={“find”: “Publications”,”filter”: {“published_date.year”: 2021,”oa_color”: 2}}
- Publication count per OA typology 2022 https://oam.oamonitor.ch/api/data/public?query={“aggregate”: “Publications”,”cursor”: {},”pipeline”: [{“$match”: {“published_date.year”: 2022}},{“$group”: {“_id”: “$oa_color”,”count”: {“$sum”: 1}}}]}
Swagger
Forschungszentrum Jülich offers Swagger, because all endpoints can be seen and tried there.
Terms of use
Forschungszentrum Jülich has a fair use policy for the API. Although there are no fixed quotas, they reserve the right to take appropriate measures should they notice above-average utilization. If you are planning very large queries, please consult oamonitor@consortium.ch in advance.
