Workforce Engagement Management

 View Only

Discussion Thread View

Historical Adherence Route Across MUs Replaced with Bulk Routing

  • 1.  Historical Adherence Route Across MUs Replaced with Bulk Routing

    GENESYS
    Posted 03-14-2024 13:51

    Hi WEM Community,

    We have an update for those of you using the the historical adherence query route, across management units. This endpoint has been deprecated and replaced by new bulk routes. The new API allows developers to make fewer and more efficient requests for historical agent schedule adherence. The old query route will not support new features going forward and will be removed on April 24, 2024. 

    Here are some notable changes between the old and new routes: 

    • The new routes will group users by management unit in the request rather than an arbitrary list of users. 

    • Actuals will no longer be returned by default. If the actuals are needed, set the Include Actuals optional parameter to true as part of the bulk-query request. You can ask for exceptions with no limitations (previously it was limited based on the number of days requested) 

    • Explanations will be applied to historical adherence calculations. 

     

    Change Context 

    Use of the old query route often resulted in the service being rate limited, slowing down the process and delaying results across the board. The new API allows developers to make fewer and more efficient requests for historical agent schedule adherence. This should create more consistent response times. 

     

    Change Impact 

    This route is still commonly used but will be deprecated to deter new adoption of the old route as we work toward transitioning over to the newer, bulk routes. The rate limit of the deprecated route will be lowered, but any existing users calling the deprecated route above the new rate limit will not have their rate limit changed. 

    For new users, as this route is being deprecated and removed, it is recommended to use the new bulk POST and GET routes going forward. Here is a tutorial on how to use the new bulk routes.   

     

    Date of Change 

    April 24, 2024. 

     

    Impacted APIs 

    POST /api/v2/workforcemanagement/adherence/historical  

    will be replaced by: 

     


    #WorkforceManagement

    ------------------------------
    Kylee Kasper, Product Manager
    Genesys - Employees
    ------------------------------


Need Help finding something?

Check out the Genesys Knowledge Network - your all-in-one access point for Genesys resources