Tech Blog

How to export data from Alma Analytics to UK Solutionpath (STREAM)

This blog will explain how to use existing Alma Analytics reports to export data from Alma Analytics to UK Solutionpath (also known as “Solution Path”).

More specifically, the data will be ingested by UK Solutionpath to STREAM (The UK Solutionpath Student Retention, Engagement, Attainment and Monitoring platform).

The export of the data from Alma Analytics is done via an API, and therefore the following blog should also be seen before continuing: How to use an API to retrieve an Alma Analytics report in 5 easy steps

For the purposes of this of this explanation we will assume that

  1. The API key which allows for retrieving Alma Analytics reports is 0123456789
  2. The institutional folder in Alma Analytics is “/shared/The YILIS institute/”

Here are the instructions:

  1. Take note that in Analytics community folder “/shared/Community/Reports/Regional User Groups/UK – SolutionPath” there are three reports to be used by UK Solutionpath:
    1. Loans Sept 2017 to 31 July 2018 for Solution Path
    2. Loans Sept 2018 to 31 July 2019 for Solution Path
    3. Loans Sept. 2019 to current day for Solution Path
  2. The Analytics API cannot be run on reports in the community folder.  Therefore create a local folder for the reports and copy them there.  Call the local folder for example as follows and copy the reports from the community folder to the local folder:
    /shared/The YILIS institute/UK – SolutionPath
  3. Let’s now focus on running the last report above ” Loans Sept. 2019 to current day for Solution Path”
    1. Change accordingly to run the other reports
  4. Take note that if you run the report manually in analytics then this is the path you will see in the URL:
    %2Fshared%2FThe%20YILIS%20institute%2FUK%20-%20SolutionPath%2FLoans%20Sept.%202019%20to%20current%20day%20for%20Solution%20Path
  5. Based on above information here is the syntax for the API
    https://api-eu.hosted.exlibrisgroup.com/almaws/v1/analytics/reports?path=%2Fshared%2FThe%20YILIS%20institute%2FUK%20-%20SolutionPath%2FLoans%20Sept.%202019%20to%20current%20day%20for%20Solution%20Path&limit=25&col_names=true&apikey=0123456789

For the above sample directory and API key this is the syntax for using the API to retrieve all three reports:

This API syntax will bring report “Loans Sept. 2019 to current day for Solution Path”.
https://api-eu.hosted.exlibrisgroup.com/almaws/v1/analytics/reports?path=%2Fshared%2FThe%20YILIS%2044institute%2FUK%20-%20SolutionPath%2FLoans%20Sept.%202019%20to%20current%20day%20for%20Solution%20Path&limit=25&col_names=true&apikey=0123456789

This API syntax will bring report “Loans Sept 2018 to 31 July 2019 for Solution Path”.
https://api-eu.hosted.exlibrisgroup.com/almaws/v1/analytics/reports?path=%2Fshared%2FThe%20YILIS%2044institute%2FUK%20-%20SolutionPath%2FLoans%20Sept%202018%20to%2031%20July%202019%20for%20Solution%20Path&limit=25&col_names=true&apikey=0123456789

This API syntax will bring report ” Loans Sept 2017 to 31 July 2018 for Solution Path”.
https://api-eu.hosted.exlibrisgroup.com/almaws/v1/analytics/reports?path=%2Fshared%2FThe%20YILIS%2044institute%2FUK%20-%20SolutionPath%2FLoans%20Sept%202017%20to%2031%20July%202018%20for%20Solution%20Path&limit=25&col_names=true&apikey=0123456789

Leave a Reply