#### Path Parameters
| Name | Type | Description |
| ----------- | ------ | ------------------------------------------------------------- |
| terms/{key} | String | lists number of occurances of each string in the provided key |
| count | String | shortcut to provide only the count of a queries response |
| sum/{key} | String | adds all the values in the provided key |
| /keys | String | lists all available keys |
#### Query Parameters
| Name | Type | Description |
| -------- | ------ | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| sort | String | Comma-separated list of keys you want your list sorted by. The list is sorted by the order the keys are provided. Prepending `:desc` to the key to reverse the sort order for that key (`:asc` is the default). |
| q | String | Allows you to filter results as desired. Your query (q) supports all elastic search terms such as AND, OR, NOT, brackets and wildcards (\*). |
| size | String | The number of items to return
Default: 10
Limit: 10,000
|
| includes | String | Comma-separated list of keys you want in your response.
Default: all
|
| from | Number | Where to start returning results from.
Default: 0
Limit: 10,000
|
| exclude | String | Comma-separated list of keys you don't want in your response.
Default: none
|
{% tabs %}
{% tab title="200: OK " %}
{% code title="Some keys omitted for brevity" %}
```json
{
"took": 3,
"timed_out": false,
"_shards": {
"total": 1,
"successful": 1,
"skipped": 0,
"failed": 0
},
"hits": {
"total": 1238652,
"max_score": 1,
"hits": [
{
"_index": "paradigm_report_works",
"_type": "_doc",
"_id": "10.1016_j.biocon.2016.06.013",
"_score": 1,
"_source": {
"supplements": [
{
"orgs": [
"Robert Wood Johnson Foundation"
],
"sheets": [
"custom_keys__rwjf"
],
"ror": "02ymmdj85",
"paid": true,
"publisher_license_crossref": "cc-by-nc-nd",
"is_preprint": false,
"publisher_simple": "elsevier",
"publisher_license_best": "cc-by-nc-nd",
"repository_license_best": "cc-by-nc-nd"
}
],
"doi": "10.1016/j.biocon.2016.06.013",
"subject": [
"Nature and Landscape Conservation",
"Ecology, Evolution, Behavior and Systematics"
],
"volume": "213",
"published_year": 2017,
"publisher": "Elsevier BV",
"published_date": "2017-09-01",
"title": "A vision for global monitoring of biological invasions",
"journal": "Biological Conservation",
"crossref_license_url_tdm": "https://www.elsevier.com/tdm/userlicense/1.0/",
"crossref_license_url_vor": "http://creativecommons.org/licenses/by-nc-nd/4.0/",
"crossref_is_oa": true,
"publisher_license": "cc-by-nc-nd",
"publisher_url_for_pdf": null,
"publisher_version": "publishedVersion",
"repository_license": "cc-by-nc-nd",
"best_oa_location_url": "https://doi.org/10.1016/j.biocon.2016.06.013",
"best_oa_location_url_for_pdf": null,
"oa_status": "hybrid",
"has_repository_copy": true,
"has_oa_locations_embargoed": false,
"can_archive": true,
"version": "acceptedVersion",
"journal_oa_type": "hybrid",
"oadoi_is_oa": true,
"is_oa": true
}
```
{% endcode %}
{% endtab %}
{% endtabs %}
## Get a CSV of works
`GET` `https://api.oa.works/report/works.csv`
Supports all the parameters provided in [#get-list-of-works](#get-list-of-works "mention")
#### Query Parameters
| Name | Type | Description |
| --------------------------------------- | ------ | ------------------------------------------------------------------------------------------------------------------------------ |
| email\* | String | Comma-separated list of emails you want to send a download link to your CSV |
| size | String | Default: 10
Format: number, or all to provide all results (up to a max of 30,000)
|
{% tabs %}
{% tab title="200: OK " %}
```
https://static.oa.works/export/report_works_8wl6t8lkjkmji2dltjuvf.csv
```
{% endtab %}
{% endtabs %}
## Get a list of organizations
`GET` `https://api.oa.works/report/orgs`
Supports all the parameters provided in [#get-list-of-works](#get-list-of-works "mention")
{% tabs %}
{% tab title="200: OK " %}
{% code title="Some keys omitted for brevity" %}
```json
{
"took": 2,
"hits": {
"total": 1,
"max_score": 0,
"hits": [
{
"_index": "paradigm_report_orgs",
"_type": "_doc",
"_id": "gxfln9cdkrs90m3xogp8m",
"_score": 0,
"_source": {
"objectID": "test",
"name": "test",
"ror": "",
"aliases": "",
"acronyms": "",
"fundref": "",
"paid": "",
"analysis": {
"is_paper": "(supplements.orgs:%22test%22 OR authorships.institutions.display_name%3A%2522test%2522%20OR%20funder.name%3A%2522test%2522)",
"is_oa": "(supplements.orgs:%22test%22 OR authorships.institutions.display_name%3A%2522test%2522%20OR%20funder.name%3A%2522test%2522) AND (publisher_license.keyword:(%22cc-by%22 OR %22pd%22 OR %22cc-0%22) OR supplements.publisher_license_crossref.keyword:(%22cc-by%22 OR %22cc0%22) OR epmc_licence.keyword:(%22cc-by%22 OR %22pd%22 OR %22cc-zero%22 OR %22cc0%22) OR repository_license.keyword:(%22cc-by%22 OR %22pd%22 OR %22cc-0%22) OR supplements.publisher_license_ic.keyword:(%22cc-by%22 OR %22pd%22 OR %22cc0%22))",
"is_free_to_read": "(supplements.orgs:%22test%22 OR authorships.institutions.display_name%3A%2522test%2522%20OR%20funder.name%3A%2522test%2522) AND (is_oa:true OR crossref_is_oa:true)",
},
"strategy": {
"email_author_aam": {
"query": "(supplements.orgs:%22test%22 OR authorships.institutions.display_name%3A%2522test%2522%20OR%20funder.name%3A%2522test%2522) AND (oa_status:%22closed%22 AND crossref_is_oa:%22false%22 AND version:acceptedVersion AND NOT supplements.sheets:%22oasupport_v2__bmgf%22 AND NOT supplements.is_free_ic:%22true%22 AND NOT supplements.apc_cost:* AND NOT journal_oa_type:%22diamond%22 AND NOT journal_oa_type:%22gold%22 AND NOT has_oa_locations_embargoed:true AND NOT type:book-chapter AND NOT supplements.is_preprint:true)&sort=author_email_name.keyword:desc,email.keyword:desc,published_date:desc",
"mailto": "{email}?subject=Article%20Request%20ref%3A{doi}&body=Dear%20{author_email_name}%2C%0D%0A%0D%0APlease%20take%20a%20minute%20to%20make%20your%20recently%20published%20article%2C%20{title}'%20open%20access%20using%20the%20instructions%20at%3A%20https%3A%2F%2FShareYourPaper.org%2F{doi}%3Femail%3D{email}.%C2%A0The%20process%20is%20easy%20and%20completely%20free%20to%20you.%0D%0A%0D%0ABy%20depositing%20your%20accepted%20manuscript%20in%20an%20open%20repository%2C%20you%20will%20enable%20equitable%20access%20and%20ensure%20your%20paper%20has%20its%20fullest%20impact.%0D%0A%0D%0AIf%20you%20have%20any%20questions%2C%20let%20us%20know.",
"export_includes": "DOI,title,publisher,journal,published_date,author_email_name,email,can_archive,version"
},
"email_author_vor": {
"query": "(supplements.orgs:%22test%22 OR authorships.institutions.display_name%3A%2522test%2522%20OR%20funder.name%3A%2522test%2522) AND (oa_status:%22closed%22 AND crossref_is_oa:%22false%22 AND version:publishedVersion AND NOT supplements.sheets:%22oasupport_v2__bmgf%22 AND NOT supplements.is_free_ic:%22true%22 AND NOT supplements.apc_cost:* AND NOT journal_oa_type:%22diamond%22 AND NOT journal_oa_type:%22gold%22 AND NOT has_oa_locations_embargoed:true AND NOT type:book-chapter AND NOT supplements.is_preprint:true)&sort=author_email_name.keyword:desc,email.keyword:desc,published_date:desc",
"mailto": "{email}?subject=Article%20Request%20ref%3A{doi}&body=Dear%20{author_email_name}%2C%0D%0A%0D%0APlease%20take%20a%20minute%20to%20make%20your%20recently%20published%20article%2C%20{title}'%20open%20access%20using%20the%20instructions%20at%3A%20https%3A%2F%2FShareYourPaper.org%2F{doi}%3Femail%3D{email}.%C2%A0The%20process%20is%20easy%20and%20completely%20free%20to%20you.%0D%0A%0D%0ABy%20depositing%20your%20publisher%20PDF%20in%20an%20open%20repository%2C%20you%20will%20enable%20equitable%20access%20and%20ensure%20your%20paper%20has%20its%20fullest%20impact.%0D%0A%0D%0AIf%20you%20have%20any%20questions%2C%20let%20us%20know.",
"export_includes": "DOI,title,publisher,journal,published_date,author_email_name,email,can_archive,version"
}
},
"policy": {
"has_policy": "",
"supported_policy": false
}
}
}
]
}
}
```
{% endcode %}
{% endtab %}
{% endtabs %}
# User accounts
When you sign up for OA.Report, we'll send you a “magic” login link that allows anyone who clicks it to access private parts of your report, including insights, in-depth analytics, and strategies.
{% hint style="warning" %}
Treat your login link like a password. Keep your login link safe, and only share it with people you trust. If your login link is no longer private, [get in touch](mailto:help@oa.report), and we'll change it.
{% endhint %}
You can log in as many devices as you want with your login link. Multiple people can also use this link. They won’t need a username or password, and you won't need to authorize their accounts. This makes it easy to give access to your report at your institution securely. Users can log out at any point, and your access will expire after one year.
{% hint style="info" %}
If you can't find your link, search your inbox for "OA.Report login link"
{% endhint %}
# How to get your data into OA.Report
OA.Report [uses data from many sources](/docs/sources) to help create comprehensive and useful information on your works. One of those routes involves [ingesting your institution's data](/docs/sources#institutions-data).
To ingest your data, we'll work with you on a dataset-by-dataset basis to figure out how to get it ingested with the least work for you. Here, we'll provide answers to common questions we get during that process.
## What is a typical workflow to set up an ingest?
1. You identify a dataset you'd like in the tool (during setup, we'll provide some ideas).
2. Share the dataset with us, or, if you can't do that describe what's in it.
3. We'll review, and provide you with a plan for how to ingest it and keep it up to date.
4. We'll implement the plan.
## What types of institutional data have you ingested in the past
See [Data sources](/docs/sources#institutions-data)
## How will you share our data?
All [OA.Report's data is public and licensed CC0](/about/licenses), and by default, that includes the data you send us. However, if your data is sensitive and can't be shared, let us know, and we'll talk you through the options available.
## How frequently should we update our data?
That's up to you.
If you've given us access to a dataset that is constantly updated, we'll normally update our copy every week. If your dataset is only periodically updated, normally we suggest sending it over monthly.
## Our data isn't clean; can you use it?
Yes. Normally, and normally we'll clean it before we use it.
## What fields should we provide?
All of them. We suggest you give us everything you can share, and we'll take whatever valuable information we can from it.
## How should we format our data?
Don't format your data specifically for us. Send us whatever you already have, and we'll build a system to translate it into what we need.
## What file types can you ingest?
We can ingest a broad set of formats, and we find the best option is whichever format is quick and easy for you to share. We'll take it from there.
For us, a Google Sheet is our preference for most datasets, followed by a CSV, or Microsoft Excel file. Providing a JSON API is also great.
## What is our "users" sheet, and how can we use it?
When you're onboarded into using OA.Report we'll provide you a "users sheet". This sheet is a general-purpose "catch all" for data you may want to contribute to OA.Report. This data could include articles you've found, corrections you'd like to make, or small amounts of additional data you'd like to add (e.g a few Grant IDs). Sometimes, this sheet can be used to get an import of data done quickly while we implement a more specific process for the dataset.
Here's a few things to keep in mind:
* Your user's sheet will be provided over email, so keep track of that somehow.
* Add any data you'd like to the "input" tab. In the headers of that tab, we'll provide documentation on what you can enter.
* If you'd like to add something there isn't a column for, please let us know and we'll make one. This ensures we can configure OA.Report to ingest your data correctly and do something useful with it.
* You don't need to tell us when you've added data. We'll automatically get notified and ingest your data in about one workday.
# FAQ
## How do I know if you're missing something?
We probably are, it's nearly impossible to find everything. If you're on our premium plan, we can ensure that we’re ingesting sources that matter to you to ensure we have good coverage. If you’d like to compare our results to others, try Lens or OpenAlex.
# Accessibility statement
For the OA.Report website
This accessibility statement applies to the present [OA.Report](https://oa.report) website and excludes other product websites ([OAbutton.org](https://oabutton.org/), [InstantILL.org](https://instantill.org/), [ShareYourPaper.org](https://shareyourpaper.org/)), our [main website](https://oa.works), and our [blog](https://blog.oa.works/).
This website is run by OA.Works. Our organization is committed to accessibility and inclusivity for all people with disabilities, in accordance with the [Public Sector Bodies (Websites and Mobile Applications) (No. 2) Accessibility Regulations 2018](http://legislation.gov.uk/uksi/2018/952/contents) (in the United Kingdom) and the requirements of [Section 508 of the Rehabilitation Act of 1973, as amended (29 U.S.C. 794d)](https://www.section508.gov/manage/laws-and-policies/section-508-law/) (in the United States).
We want as many people as possible to be able to use this website. For example, that means you should be able to:
* Zoom in up to 400% without the text spilling off the screen.
* Navigate most of the website using just a keyboard.
* Navigate most of the website using speech recognition software.
* Listen to most of the website using a screen reader (including the most recent versions of JAWS, NVDA and VoiceOver).
We’ve also made the website text easy to understand using Simple English (US).
We continue to improve the website’s accessibility and performance for as many devices as possible. We do not, however, support Internet Explorer.
[AbilityNet](https://mcmw.abilitynet.org.uk/) has advice on making your device easier to use if you have a disability.
### Measures to support accessibility
OA.Works takes the following measures to ensure accessibility of the OA.Report website:
* Included accessibility throughout our internal policies.
* Appointed an accessibility officer.
* Assigned accessibility goals and responsibilities.
### Conformance status
The Web Content Accessibility Guidelines (WCAG) define requirements for designers and developers to improve accessibility for people with disabilities. It defines three levels of conformance: Level A, Level AA, and Level AAA.
OA.Works’ website is fully compliant with the **Web Content Accessibility Guidelines (WCAG) version 2.2 AA** standard.
#### Known accessibility problems
None found following an accessibility audit conducted on 13 March 2026.
### Feedback and contact information
We welcome your feedback on the accessibility of the OA.Report website. Please let us know if you encounter accessibility barriers or if you need information on this website in a different format:
* Email:
* Phone: [+1 (631) 498-8938](tel:+16314988938)
We try to respond to feedback within seven days.
### Preparation of this accessibility statement
This statement was prepared on 22 June 2023. It was last reviewed on **27 April 2026**. This website was last tested on 13 March 2026.
[Torchbox](https://torchbox.com/) carried out an accessibility audit on 13 March 2026 using the following methods:
* Automated tools:
* Accessibility Insights for Web (Axe, Chrome).
* Manual testing:
* Keyboard navigation testing (Chrome)
* Screen reader testing (VoiceOver on macOS, Safari)
* Full-page zoom testing (Chrome, up to 400%)
* General manual accessibility testing (Chrome)
Our own team at OA.Works provided fixes to the issues found in the audit and re-tested them using:
* Automated tools: [Lighthouse](https://developers.google.com/web/tools/lighthouse/) and [axe](https://www.deque.com/axe/) (via [Ghost Inspector](https://ghostinspector.com)).
* Manual testing: MacOs’ VoiceOver and navigating using just the keyboard.
# Known issues
* None at the moment!
# Report an issue
Oh no! Thanks for reporting the issue.
Let us know however works for you. e.g. can [send us an email](mailto:help@oa.report), comment on a Google Sheet we've sent you, or provide a spreadsheet with comments. What's most important is a clear description of what's wrong, what you expect, and an example or two.
# Contact
Email us at or say hi on Twitter [@oa\_works](https://twitter.com/OA_Works)