Genesys Cloud - Developer Announcements!

Summary

The API usage visualisations available under:

• Admin → API Usage report

• Performance → Workspace → API usage report

are being deprecated, along with the legacy API usage endpoints listed below.

New API usage endpoints are now available as replacements, offering more granular data and enhanced filtering capabilities.

Planned Removal : On or after 16 October, 2026 (subject to 0 usage)

Effective Date

Tuesday, May 5, 2026

Details

The deprecated UI components will be replaced with an updated Usage UIthat organises usage data by meters.

The legacy APIs provided only high-level aggregations, which limited usability for customers working with larger datasets. The new endpoints maintain existing capabilities while enabling:

• More detailed (granular) data retrieval

• Greater control over filtering and data output

Customer Impact

• Customers can continue using the current API Usage UI until it is removed and replaced with the new meter-based UI.

• If the updated UI does not meet reporting needs, usage data should be retrieved via the new API usage endpoints.

• Customers using legacy endpoints programmatically must migrate to the new endpoints before removal to avoid disruption.

Impacted Resources

• api/v2/usage/simplesearch
• api/v2/usage/simplesearch/{executionId}/results
• api/v2/usage/query
• api/v2/usage/query/{executionId}/results
• api/v2/usage/datatransfer/aggregates/query
• api/v2/usage/datatransfer/aggregates/query/results/{executionId}
• api/v2/oauth/clients/{clientId}/usage/query
• api/v2/oauth/clients/{clientId}/usage/summary
• api/v2/oauth/clients/{clientId}/usage/datatransfer/aggregates/query

Issue References

[USAGE-2443]

Contacts

Please reply to this announcement with any questions. This helps the wider developer community benefit from the discussion. We encourage you to use this thread before contacting the designated person directly. Thank you for your understanding.

Thank you to everyone who has already migrated to our new endpoints and shared your feedback, it's been incredibly helpful. As a reminder, the older versions of these endpoints (listed above) are now deprecated. To ensure your applications that rely on these older endpoints continue to run smoothly, please transition to the updated versions below:

'api/v2/usage/aggregates/query/jobs', 
'api/v2/usage/aggregates/query/jobs/{jobId}', 
'api/v2/usage/client/{clientId}/aggregates/query/jobs', 
'api/v2/usage/client/{clientId}/aggregates/query/jobs/{jobId}'

Let us know if you run into any issues while upgrading!