Reporting

OpenAthens’ reporting uses transfers as the unit of measurement and UTC for the dates and times. A transfer occurs when your system sends the user to their home organization and that organization sends them back with attributes; it's the sending back that we count. UTC is Coordinated Universal Time: https://en.wikipedia.org/wiki/Coordinated_Universal_Time

We don't know if you let the user in or not. This means that reports can include organizations that do not subscribe to your content, which may be of interest to your sales team.

There are two reporting options:

Summary report

The summary report shows you the totals for the last 7 or 30 days, and has a download option. Keystone apps include 1:1 connection data.

You can also view the top organizations, countries and your applications (if you have more than one). Downloads include more information (see below) so you can link it to other data or split out distinct sub-organizations if a customer has them (e.g. UK NHS). For most viewers, there won't be a difference between organizations and parent organizations - see the information below for the difference.

Summary report, showing the total number of transfers and unique organizations, followed by a breakdown of transfers per organization, for 'Top parent organizations' over the past 30 days. There is also a button labeled 'Download full report'.

Summary report, showing the total number of transfers and unique organizations, followed by a breakdown of transfers per application, for 'Top applications' over the past 30 days. There is also a button labeled 'Download full report'.

Custom report

The custom report lets you select many options and also has a download option (CSV).

You can select for applications, organizations, countries, and date ranges. Applications and, especially, organizations and countries can be a long list so are searchable. The country will be that of the federation the organization is first registered in, unless they're one of ours in which case we use our own customer data. External apps will show only the OpenAthens federation.

Downloads include more information (see below), so you can link the report to other data or split out distinct sub organizations if a customer has them (e.g. UK NHS).

Example of a custom report. A table shows transfers broken down by organization and application. There are filters for 'Application', 'Organization', 'Organization country', 'Start date' and 'End date'. There is also a button labeled 'Download this report'.

Anything else I need to know?

We would love to hear your thoughts and there's a feedback widget on the page you can use (it won't appear if you've blocked cookies). You can also write to feedback@openathens.net.

For the summary and custom reports:

the earliest date available is 1 August 2023 for Keystone apps and 1 January 2024 for External apps
the downloads for customer and summary reports contain the same data fields, but the data is limited based on your selections
the download is a flat CSV file containing the following fields:
- Parent organization
  - The name associated with their entityID
- Organization
  - The name associated with their scope (could be a different organizational unit)
  - If the scope is blank this will default to be the same as the parent organization
- Scoped affiliation
  - e.g. member@stlukesuniversity.ac.uk
  - Will be blank if the IdP is sending a non-standard value
- Org entity id
  - e.g. https://idp.stlukesuniversity.ac.uk/openathens
- Org registration federation
  - e.g. OpenAthens Federation, EduHr, 1:1 connection, etc
- Org country
  - Colloquial English name - e.g. "Mexico" instead of "Estados Unidos Mexicanos" or "United Mexican States"
- Transfer date
- Application name
- Application type
  - Keystone or External
- Application id
  - e.g. coolpublisher.org.oidc-app-v1.2b3e123a-26d0-4a65-a6c7-3148089a2f69
- Transfers
downloads are not available via API but if that would be of interest to you, there are feedback options listed above.