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:

• find
• aggregate
• count
• distinct
• getMore
• mapReduce
• listCollections

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 2018-2022: https://oam.oamonitor.ch/api/data/public?query={“aggregate”: “Publications”,”cursor”: {batchSize: 1000},”allowDiskUse”: true,”pipeline”: [{“$match”: {“year”: {“$gte”: 2018, “$lte”:2022}}} ,{“$group”: {“_id”: { “oa_type”: “$oa_color”, “year”: “$year”}, “count”: {“$sum”: 1}}}]}

• By institution category, published between 2018-2022: https://oam.oamonitor.ch/api/data/public?query={“aggregate”: “Publications”,”cursor”: {batchSize: 1000},”allowDiskUse”: true,”pipeline”: [{“$match”: {“year”: {“$gte”: 2018, “$lte”:2022}}},{“$unwind”: “$dim.organisations”},{“$group”: {“_id”:{“type”: “$dim.organisations.type”, “oa_type”: “$oa_color”, “year”: “$year”}, “distinct”: {“$addToSet”: “$_id”}}}, {$project: {count:{“$size”:”$distinct”}}}]}

• By institution, published between 2018-2022: https://oam.oamonitor.ch/api/data/public?query={%22aggregate%22:%20%22Publications%22,%22cursor%22:%20{%20batchSize: 10000},%22allowDiskUse%22:%20true,%22pipeline%22:%20[{%22$match%22:%20{%22year%22:%20{%22$gte%22:%202018}}},{%22$unwind%22:%20%22$dim.organisations%22},{%22$group%22:%20{%22_id%22:{%22organisation%22:%20%22$dim.organisations%22,%20%22oa_type%22:%20%22$oa_color%22,%20%22year%22:%20%22$year%22},%20%22count%22:%20{%22$sum%22:%201}}}]}

Examples for other queries

• All Gold-OA publications from 2020 https://oam.oamonitor.ch/api/Data/public?query={find:”Publications”, filter:{year: 2020, oa_color: 7}}
• All Green-OA publications from 2021 https://oam.oamonitor.ch/api/Data/public?query={find:”Publications”,filter:{year: 2021, oa_color: 2}}
• Publication count per OA typology 2022 https://oam.oamonitor.ch/api/Data/public?query={aggregate:”Publications”,cursor:{},pipeline:[{$match:{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.