Get Available Metrics with API

Platform API
1

I would like to use the API to get the metrics described in "Available Metrics" on the "Add and edit Performance Dashboards" page.
For example, I would like to know which API I need to use to get "Abandon" on "Metric widget queue metrics" in Available Metrics.
Also, please let me know if there is a URL where you can refer to the acquisition method using the API.

2

Hi,

The POST /api/v2/analytics/conversations/aggregates/query is the source for that data.
There is a comprehensive article on the developer center providing a lot of detail on the conversation aggregate query.

You may find the analytics query builder helpful for generating and testing analytics queries

3

Hi Ronan

Thanks for your answer.

"POST /api/v2/analytics/conversations/aggregates/query "

Using this API, I can directly obtain 41 metrics, but actually there are about 100 metrics in the "metric widget queue metrics" of "available metrics". Do other metrics need to be calculated by directly obtained metrics?

Is there any contrast between the name of metric in resource center and the variable name of metric in API? I can't confirm which metric the variable name of metric in API actually corresponds to.

Thanks，
Miao

4

You can find documentation on the reports and views here: https://help.mypurecloud.com/articles/about-reports-views-and-dashboards/. Each page documents how the columns/fields are calculated. This should give a good mapping of what you're seeing in the UIs to data from the API, though the names in the UI and API are not a 1:1 match. If there are any that are unclear, please ask.

5

Hi,

Thank you for your answer. Sorry for the late reply.

My customer has also requested to use the API to get the following items in "Available Metrics" as well:

  • "Metric widget user metrics"
  • "Metric widget wrap-up metrics"
  • "Metric widget flows metrics"
  • "Metric widget flow outcomes metrics"
  • "Agent status widget user metrics"

Please let me know if there is an API that can be obtained and a URL that can be used as a reference.

Please let us know if you have any questions.

6

Hi,

I would like an answer to this question.
Please tell me if the information provided is insufficient if.

7

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