Genesys Cloud - Developer Community!

 View Only

Sign Up

  • 1.  API Rate Limits for POST /api/v2/analytics/queues/observations/query

    Posted 05-27-2025 23:47
    We are planning to issue the following API once per flow execution in order to retrieve the number of waiting calls in a queue flow:
    POST /api/v2/analytics/queues/observations/query
     
    Planned API Call:
    https://developer.genesys.cloud/devapps/api-explorer?requestConfig=eyJvcGVyYXRpb25JZCI6InBvc3RBbmFseXRpY3NRdWV1ZXNPYnNlcnZhdGlvbnNRdWVyeSIsImJvZHkiOnsibWV0cmljcyI6WyJvV2FpdGluZyJdLCJmaWx0ZXIiOnsidHlwZSI6Im9yIiwiY2xhdXNlcyI6W3sicHJlZGljYXRlcyI6W3sidHlwZSI6ImRpbWVuc2lvbiIsImRpbWVuc2lvbiI6InF1ZXVlSWQiLCJvcGVyYXRvciI6Im1hdGNoZXMiLCJ2YWx1ZSI6ImY3ZmYxNDBlLTY0Y2UtNGZkNC1iMjNhLTY4YjUxMTgwOGE5YiJ9XSwidHlwZSI6Im9yIn1dfX0sImhlYWRlcnMiOltdfQ==#post-api-v2-analytics-queues-observations-query
     
    The API documentation describes the following two rate limits:
     
    client.credentials.token.rate.per.minute (default: 300, extended to 1000)
     
    activity.rate.per.second (fixed at 20, not extendable)
     
     
    Question:
    Do the applicable rate limits vary depending on the specified metrics (e.g., oWaiting, oActiveUsers)?
     
    Background:
    Our current CPS (calls per second) is 20, and the customer requirement is 40 calls/sec. This means there is a potential risk of exceeding the activity.rate.per.second limit.
    Therefore, we would like to confirm whether this API is subject to both the client.credentials.token.rate.per.minute and activity.rate.per.second limits.


    #PlatformAPI

    ------------------------------
    yusuke yoshihara
    .
    ------------------------------


  • 2.  RE: API Rate Limits for POST /api/v2/analytics/queues/observations/query
    Best Answer

    Posted 05-28-2025 08:53

    Hi Yusuke,

    As I read the documentation you would be subject to both.  The client.credentials.token.rate.per.minute limit is an overall platform API limit, while the activity.rate.per.second is an API specific limit.  Generally, for analytics data especially around the observations/query endpoint, I recommend you use the Genesys  AWS EventBridge integration for near-time data calls.  If you are building a UI you could look at our websocket/notification integration.

    Thanks,
         John



    ------------------------------
    John Carnell
    Director, Developer Engagement
    ------------------------------



  • 3.  RE: API Rate Limits for POST /api/v2/analytics/queues/observations/query

    Posted 05-29-2025 03:31

    Hi John

    Thank you for the explanation.
    I understand that both limits apply.

    Thanks,
    Yusuke



    ------------------------------
    yusuke yoshihara
    .
    ------------------------------