search

AgoraIO / Docs-Source

A repository for the Agora Docs source content.
MIT License
20 stars 11 forks source link

Agora Analytics RESTful API updates #1322

Closed Nero-Hu closed 1 year ago

Nero-Hu commented 1 year ago

The RESTful APIs of data insights and real-time monitoring has been updated and released in the CN market. The source is here and has been reviewed by @anastasia: aa_api.md Please diff it with the current version to see what updates has been made.

Btw, the release notes needs to be updated as well.

Nero-Hu commented 1 year ago

Please double-check the API limits with the product manager before releasing. The limits affect the pricing plans. @atovpeko

atovpeko commented 1 year ago

@Nero-Hu a few notes and questions:

  1. The attached API file is empty.
  2. For the release notes, can I have the input as well?
  3. Who's the product manager I need to sync with for API limits?
Nero-Hu commented 1 year ago

@atovpeko

  1. Sorry. My bad, the API source file: aa_api.md

  2. The release notes（translated by chatGPT）: This release includes updates to some RESTful APIs under the Real-Time Communication (RTC) product:

Data Insights RESTful API: Added a new query interface for aggregated quality metrics, which can be used to obtain aggregated usage metrics under a specified dimension for a specified time range. Added a new query interface for aggregated usage metrics, which can be used to obtain aggregated quality metrics under a specified dimension for a specified time range.

Real-time Monitoring RESTful API: Added "dimension" and "dimensionValues" parameters to the query real-time scale and query real-time quality interfaces, which can be used to specify the query dimension. Added a new query interface for top 20 real-time scale metrics groups, which can be used to obtain the top 20 groups of real-time call volumes under a specified dimension. Added a new query interface for top 20 real-time quality metrics groups, which can be used to obtain the top 20 groups of quality-related metrics under a specified dimension.

The releasenotes basically introduces the new parameters and new RESTful APIs. You may need to add some links.

  1. Pavan Kumar Pakala
Nero-Hu commented 1 year ago

image The headings I underlined is actually an unsolved comment in Anastasia's review which she didn't reply. Check here: image May be you need to discuss it with Ana and decide whether to use "time-series" or "time-frame", or other options. @atovpeko @anastasia

atovpeko commented 1 year ago

@Nero-Hu Apologies, I somehow missed you needed my input in a thread. It seemed that you were just liking and resolving my comments. My general concern is that the same concept should not be named different names, because that leads to confusion. If your goal was to underline the difference, then we're good.

Nero-Hu commented 1 year ago

@atovpeko OMG! I have just realized that Ana and Atovpeko are the same person, and I am truly sorry for any confusion or inconvenience this may have caused. Before, I had mistakenly believed that Ana was a reviewer and Atovpeko was an Indian writer managed by Iain, which led me to suggest that Atovpeko and Ana should discuss the matter together. I now realize that this was incorrect, and I deeply regret any assumptions or biases I may have demonstrated.

Moving forward, I wanted to bring to your attention that the current sub-headings in the English document for the two APIs are different, while the Chinese document uses the same words for both. As the APIs are of the same nature, albeit one querying usage and the other quality, I suggest that we consider unifying the headings in the English document to avoid any confusion.

Once again, please accept my apologies for any inconvenience caused. I appreciate your understanding.

atovpeko commented 1 year ago

@Nero-Hu absolutely no problem, GitHub handles are confusing for everybody :-). Thank you for bringing this to my attention - I'll take a closer look at sub-headers then.