This guide provides information on reading the reports generated for premium members about their integrations with ORCID.
Accessing your reports
The member newsletter sent monthly from ORCID contains a link to a Google Drive folder where all of your member reports are stored.
- Premium members with active integrations receive a unique link to a folder containing separate, customized reports with data for each integration in the prior month.
- Premium members who don't have an active integration yet receive a unique link to a folder containing customized reports with email statistics for their institution, as well as a link to a folder which contains general reports with aggregated data for all active member integrations.
- Basic members receive a link to a folder containing general reports issued twice annually with aggregated data for all active member integrations in the prior half year; the first half of the year report is issued in July (January-June data), the second half of the year report issued in January (July-December of the following year).
If you are an ORCID member and do not currently receive the monthly member newsletter, please contact firstname.lastname@example.org
Premium members with active intgrations
The Google Drive folder contains a member report for each of the production client iDs issued to you. The file names include the display name of the client iD and the date of the report; please sort by date modified to find the most recent report. There is also a raw_data folder containing the data used to generate the report, which is available for additional analysis if required.
Premium members who don't have an active integration yet
The Google Drive folder contains a member report with email statistics data only, as well as a link to a Google Drive folder of general monthy reports with aggregated data for all active member integrations, for the current and previous years. Raw data is not available for these reports.
Email domain counts
This section provides counts of ORCID iDs currently registered your institution's email domains(s) across all time periods. To generate these counts, we search for domains that match the website URL we have on file for your organization (ex: if your website URL is www.universitycollege.edu, we search for emails ending in @universitycollege). If we don’t have a website URL on file, you’ll see “No email domains provided” in this section. If we didn’t get your email domain quite right, or if you’d like to add additional domains, please contact us.
- Records registered to your email domains Count of unique ORCID iDs that include an address within your institution’s email domain(s)
- Records registered to your email domains AND associated with your client ID Count of unique ORCID iDs that include an address within your institution’s email domain(s) AND that include your institution as a Trusted Party (ie: records that your institution has a valid access token for)
Created and claimed records
(Note: most clients will not have this section in their reports)
If you have an institutional client that was used to create records on behalf of researchers via the API, you will receive a section called Registry Statistics. This includes information about the number of records you created and how many have been claimed (the raw_data file contains more information about the specific records used to generate these numbers).
This section of the report contains a total count of the number of researchers who used your integration to connect their ORCID iD to your system over the month of reporting. In addition, it gives the total number of those researchers who signed up for a new ORCID iD as a part of the iD connection process.
The graph labelled Total Integration Events shows the number of researchers who used your integration over the last month, by day
The report also contains events information, the actions that the researcher completed when connecting their ORCID record with your system in the month of reporting. Each event represents any access the user granted or action they did on the ORCID site (such as signing in or giving read-limited access). Most researchers will have more than one event associated with them.
If an event has a “P” appended to it, this signifies that the researcher granted a persistent (long-lived) token, as compared to a short-lived token which expires in one hour. (The researcher chooses this on the OAuth screen when they decide to either uncheck or leave checked the box which states "Allow this permission until I revoke it".)
Users by country
The final section of the reports contains information about the researchers who used your integration broken down by the country from which they accessed your integration. This data is derived from a researcher’s IP address or their Geographical ID (itself determined by Google from the researcher’s IP address).
Because so many researchers use the ORCID Registry, it’s not feasible to run reports on the entire set of researcher data. Instead the numbers provided here are produced using trends from a sampled and non sampled set. The sections of the report derived from sampled data are signalized with an asterisk, and the sampled size and space are specified on the Analytics data tab. The numbers in the Google Analytics section of the report may not entirely match any local statistics you keep, and there may be small discrepancies in the count between sections of the report.
The sampling parameters listed beneath Integration Analytics apply to all all sections marked with an asterisk. The percentage of sessions captured by the analytics data is (sample size)/(sample space) * 100%. Further information on sampling can be found at Google Developers.
The Users and Events sections of the report only include data from the past month. If no researchers have used your integration in the past month, then no data will be returned.
If you have any questions about your member reports, please contact us.