Description
We are happy to announce that we're ready to take on beta customers for our new async style aggregates endpoint! The official start date for this beta was November 30, 2022. This beta is currently API only; there are no UI components currently using this query methodology, but exports will be leveraging this endpoint next year. Enabling this on your org will have no impact on the UI, it will simply make the endpoint available for your org for custom development and endpoint testing.
What is an async query?
Synchronous style API requests are designed for small data requests where the results can be pulled piece by piece, but can be difficult to work with for large data requests. Often this requires additional filtering to be added or the intervals to be kept small; leaving the developer to contend with rate limits and stitch the data together.
Async queries allow for a user to make a data request and give the service time to assemble the results. The user then later makes a secondary request to retrieve the results. For applications that need to download larger amounts of data or apply complex filtering, async requests open the door for the ability to submit as complex of a query as you'd like. There are of course going to be some data requests that still could be too large, but for the most part pulling multiple years of data in a single request is no problem for the new endpoint.
Is there a data delay like the /jobs endpoint for detail data?
No there is not. The aggregate jobs endpoint pulls from the same data store as the current aggregate endpoint. The data received from the synchronous vs asynchronous endpoint for aggregates will have no differences at all. The main benefits to the consumer is the ability to queue large requests for applications that can wait several minutes for a request to be returned. On the service side, this allows us to separately queue these requests to give priority to the realtime queries that can't afford to wait for results to returned.
Where can I learn more?
Documentation for the preview APIs is available here. Filter on "aggregates/jobs" to see all the available endpoints for this beta.
What are the goals of the Beta?
We are planning to vet any issues with the release before going to production to allow our customers and partners to stress test this service. We also plan to adjust the predicate limits, timeout limits, and performance of the service as we see real use cases come through as customers utilize the service.
Where do I report issues?
You may reply to this thread or email me directly to discuss any potential issues you run into during the beta phase.
How do I enroll?
Please email ryan.legner@genesys.com with your organizationID, region, and a contact point to sign you up for the beta. We will contact you to confirm you’ve been enabled.
Change Category
Informational
API
Change Context
Enable applications to have a better avenue for querying complex aggregate data and large batch sizes.
Change Impact
None. Enabling this beta allows the organization access to new endpoints that are in the beta phase of release. No existing user functionality currently uses this new endpoint.
Date of Change
Nov 30, 2022
Impacted APIs
No impact to any existing APIs.
References
[PURE-4036]