In a previous blog post we explained how to design an API Analytics solution, and highlighted the key questions that an analytics solution tailored for an API Product Manager should address. In this article, we are focusing on the API relationship manager and his specific needs and role.
The API relationship manager manages the relationship with the ecosystem, resolves incoming issues and inquiries. For him (or her), the ecosystem’s experience and satisfaction is key.
To manage success, the API relationship manager needs systematic identification of consuming applications with abnormal activities, with bad consumer experience, or top consuming applications. He needs an API analytics solution that includes operational dashboards with immediate identification of abnormal situations in order to fix them before they become critical and addresses the following questions:
- What are the top consuming applications: the most active consuming applications in my system.
- Are there consuming applications with churn risk: consuming applications delivering bad experience, which means with high failure rate, high response time or with high exception rate.
- And finally, what is the reason for a consuming applications bad experience?
The solution should includes a homepage (a cockpit), which is the main entry dashboard to the analytics solution and provides a global health view and high level information to the API relationship manager.
The cockpit dashboard
The cockpit dashboard should includes metrics and risk evaluations that require user attention and immediate action when metrics reach critical thresholds. Metrics such as:
- number of consuming applications with high failure rate
- number of consuming applications with high response time
- number of consuming applications with exceptions
The cockpit dashboard can also indicate whether the problem is new or old, and whether the situation is improving or not. And finally shows the list of these consuming applications with abnormal or unexpected behavior.
The API relationship manager may need additional useful indicators that shows the current activity performance:
- total number of completed API calls
- average failure rate
- average response time
- average transactions per second
All that with their trends and top 10 client applications in terms of traffic to assess the impact of any risk.
The detail dashboards
Details can be accessed from the cockpit dashboard if needed by drilling down on key metrics and graphs to access the individual consuming applications level (dashboard). The consuming applications dashboard should provide information such as list of API methods called by the consuming application, traffic trend, response time , failure rate and exceptions.
Then, API relationship manager should be able to access detail of an API method to understand how it was used by the chosen client application. So he can see the current traffic trend compared to previous day or week, understand recurring problems and patterns, failure rate and exceptions count. These indicators provide immediate view on the daily quality traffic and help to spot unusual traffic trend.
The API relationship manager should also have access to an (advanced) search capabilities to look for any client applications that issued API calls and access any related information to analyze trends.