Skip to main content
ExLibris
  • Subscribe by RSS
  • Ex Libris Knowledge Center

    API Usage

    Translatable
    Analytics

    Using the API Usage subject area, the Design Analytics user may create reports and dashboards. The following are examples of business questions that can be answered with the API Usage subject area:

    • How many APIs of type x were executed in the last year?
    • What are the 10 most used APIs by API name?
    • Display a graph of API types by month for the past 3 years
    • Display the number of APIs by module

    API_usage_star_diagram.png

    Star Diagram – API Usage

    Field Descriptions

    The following lists the fields available in API Usage.

    API_usage_field_descriptions.png

    API Usage – Field Descriptions

    API Measures

    The API Measures table is a fact table stores all the measures API usage.
    API Measures
    Field Description Additional Information
    API Usage - Acquisitions API usage for acquisitions  
    API Usage - Analytics API usage for analytics  
    API Usage - Bibliographic API usage for bibliographic  
    API Usage - Configurations API usage for configurations  
    API Usage - Courses API usage for courses  
    API Usage - Electronics API usage for electronics  
    API Usage - Physical Items API usage for physical items  
    API Usage - Resource Sharing Partners API usage for resource sharing partners  
    API Usage - Tasks List API usage for tasks list  
    API Usage - Users API usage for users  
    API Usage - Other API usage for other areas  
    API Usage - Total Total API usage  

    API Details

    The API Details table is a dimension table that stores details regarding API usage.
    API Details
    Field Description Additional Information
    API Area The API area  
    Application Name The application name  
    Application Key The application key  
    API Method The API method  
    API URL The API URL  
    Product The product  

    API Dates

    The API Dates table is a dimension table that stores details regarding API usage dates.
    API Dates
    Field Description Additional Information
    Execution Date Stores the date in the date format 2/29/2012  
    Execution Date Filter Used to filter report results by date.  
    Execution Quarter Stores the quarter of the date in a display format such as Q1  
    Execution Year Stores the year of the date in string format such as 2012  
    Execution Fiscal Year Stores the fiscal year of the date in string format such as 2012.  
    Execution Month Stores the month of the date in month description format such as February  
    Execution Month Key Stores the month of the date in number format such as 2 for February  
    Execution Fiscal Month Stores the fiscal month of the date in month description format such as February  
    Execution Full Month Stores the month and the year of the date in a display format such as Feb 12  
    Execution Start Of Week The date of the first business day of the week  
    Execution Week Number The number of the week of the year  
    Execution Date Stores the Hierarchy column that allows the user to drill down from the year to the month to the specific loan date. Using this column provides the user with the option to view the accumulative measures in each level of the hierarchy.  

    Institution

    The shared Institution dimension allows the Network Zone to view reports according to institution. It is available in every subject area. It contains the following fields:
    Institution
    Field Description Additional information
    Institution Code The code of the institution.  
    Institution Name The name of the institution.  
    Institution Timezone The timezone of the institution  
    Data Available As Of When the data became available to analytics  
    Data Updated As Of When the data was taken from Alma  
    If an analytics report is run from the Network Zone in a collaborative network implementing a Network Zone, all member institutions are included in the report for Institution Code and Institution Name.
    If an analytics report is run from an institution that is not part of a collaborative network implementing a Network Zone, only the single institution from which the report is run is included in the report for Institution Code and Institution Name.
    Reports involving data across a collaborative network implementing a Network Zone may take longer to run than reports within one institution.
    • Was this article helpful?