Analytics Conversation Detail Endpoint API maximum record per query change

Category: API

Summary: Analytics Conversation Detail Endpoint API maximum record per query change

On December 9, 2020, Genesys will change the Analytics Conversation Detail Endpoint API (/api/v2/analytics/conversations/details/query) to return a maximum of 100,000 records per query. For more information, see Analytics Conversation Detail Endpoint API maximum record per query change

Context: The motivation for the change is to address stability concerns with our data tier.

Impact: Customers will not be able to page results past 100,000.

Date of Change: Dec 9th, 2020.

Impacted API's :

  • /api/v2/analytics/conversations/details/query

References: BAD-412

PSA: This has been updated to support 100,000 instead of 10,000.

Just double checking: this is not related to paging through result sets? Rather, if we say query large intervals where we expect more than 10'000 results for the entire query, we should either split the queries into multiple smaller, or switch to using e.g. the /jobs endpoints?

You will be able to page through the results until the 10,000th result. At that point, the query will fail if you attempt to page further using the query endpoint.
If you don't need the results in realtime, the jobs endpoint will be more convenient and resilient to handle this. The jobs endpoint has no max result size.

Alright, thanks for clarifying.

Hello
Is-there a simple way to get in realtime (via the notification API for example) ALL inbound/outbound conversations (that has reached a queue or not) in the system ?
Thanks

No. The earliest point you can get conversation notifications is when they hit a queue or user. There is not a "system conversations" type topic. You can request new features and share your use case at https://genesyscloud.ideas.aha.io/.

I have created a new Idea for something like this that i was wanting as well. CLPLA-I-1001

Ok thanks for your answer.

In deed. I voted for your idea instead of creating a new one. Thanks

Can I differentiate between an normal(inbound,outbound) & callback from this api?

Our current Informatica process calls the API, if there is data it gets loaded, and then we make another call to the API again to check the next page and this repeats until we find a page with no data in which case the process ends. As we are making a call to the API for every new page, am I correct in saying we should not be affected by this change? Or does it mean when we reach the 10000th page we won’t find data?

Hi ,

if we call conversation details api using interval start and end and also Page No 1, and again call api with page 2

Will it be called one call per page and 10,000 records limit will not be applicable unless a single page returns more than 10,000 records.

Are there specific examples how it will impact existing api queries as reducing the interval range is not working? We have found reducing interval range increases duplicate entries which blow up the 10,000 records range.

is it possible to provide us with access to test the purecloud changes, so that we can test our development changes before the purecloud changes Go Live.

Hi Viren,

Yes, if your query is returning that amount of results it is recommended you update your query to produce smaller result sets. Consider querying for a smaller interval and/or filtering for specific dimensions and metrics.

1 Like

What would be the error code when the endpoint reach the 10000 ? is there any kind of "test" endpoint to work on it?

You are now only allowed to fetch a total of 10,000 records. Eg. if your query matches 13,000 results, you will only be allowed to scroll until 10,000 results. If you need to fetch the additional 3000 results, you will just be required to break your existing query into two separate queries.

Hello,
could you please clarify... the limit is 10.000 records or 100.000 records ?

in this link: https://help.mypurecloud.com/articles/analytics-conversation-detail-endpoint-query-change/
it says:

On December 9, 2020, the Analytics Conversation Detail Endpoint (/api/v2/analytics/conversations/details/query) will return a maximum of 100,000 records per query.

Hello,

The limit appears to be 100 000 records now.
I see that the original post in this thread was updated recently (in November) changing from 10 000 to 100 000, with this comment: "PSA: This has been updated to support 100,000 instead of 10,000."

Regards,

Okay, the limit will be at 100'000. Thanks for the confirmation.

This topic was automatically closed 62 days after the last reply. New replies are no longer allowed.