Description
Beginning March 31st, Customers will have access to a new Usage Query service with improved customer control and visibility. With these new APIs, customers have new functionality to allow for pagination and page size control.
-
What customers will get: Improved experience querying data. More access to their data, there’s security controls so they can access only their data but we do less filtering and forcing the queries so they can query exactly what they want.
-
Example: For the organization endpoint, previously all requests where the oauthClientOrgId = purecloud or purecloud-builtin were filtered out, now that data is returned.
-
Example: as stated in the descriptions for each query, customers can add more filter requests like specifying the oauthClientIds, platforms, userIds, httpMethods, templateUris they want to see usage for (for the organization endpoint).
-
-
What customers won’t get: Their billing usage, these are ALL requests made, not just the billable ones. And we have no responsibility for saying what is and is not billable.
Change Category
Informational
API
Change Context
There are several APIs with inherent restrictions that make it difficult at times for customers to get full visibility into the usage data they desire. This new service will improve the overall customer experience.
Change Impact
Customers can now query the new APIs. Customers will still have access to the old APIs however the expectation is to deprecate those in the future.
Date of Change
31 Mar 2025
Impacted APIs
New:
POST api/v2/usage/aggregates/query/jobs
GET api/v2/usage/aggregates/query/jobs/{jobId}
POST api/v2/usage/client/{clientId}/aggregates/query/jobs
GET api/v2/usage/client/{clientId}/aggregates/query/jobs/{jobId}
Old:
POST api/v2/usage/query post-api-v2-usage-query
POST api/v2/usage/simplesearch post-api-v2-usage-simplesearch
GET api/v2/usage/query/{executionId}/results get-api-v2-usage-query--executionId--results
GET api/v2/usage/simplesearch/{executionId}/results get-api-v2-usage-simplesearch--executionId--results
POST api/v2/oauth/clients/{clientId}/usage/query post-api-v2-oauth-clients--clientId--usage-query
GET api/v2/oauth/clients/{clientId}/usage/summary get-api-v2-oauth-clients--clientId--usage-summary
GET api/v2/oauth/clients/{clientId}/usage/query/results/{executionId} get-api-v2-oauth-clients--clientId--usage-query-results--executionId-
References
[USAGE-1513]