API Metrics in ReadMe

Documentation + API Metrics = πŸ’œ

So you've put in a lot of time and effort into building out beautiful documentation for your API using ReadMe. Excellent!

But good API experiences aren't just centered around well-written documentation. What if there was a way to develop a better understanding of how your users interact with your API, and use that knowledge to make your users' experience with your API even better? Enter API Metrics!

When your users are using your developer hub with API Metrics enabled, they'll be up and running with your API in no time! Users of your API will be able to:

  • Construct an API request, make the request, and view the full log of the API request and response, all without leaving the documentation
  • Debug errors with ease with detailed API logs that include links to corresponding endpoints in your API reference documentation
  • View the exact same logs as your team, making customer support a breeze

Read on to learn more about API Metrics and how it can improve your users' experience with your API!

API Metrics Dashboard

The API Metrics Dashboard gives your team the ability to segment your APIs logs by status code, endpoint, method, user or any combination of those four filters.

You can read more about the API Metrics Dashboard here.

View metrics about your API directly in the ReadMe dashboardView metrics about your API directly in the ReadMe dashboard

View metrics about your API directly in the ReadMe dashboard

API Logs in the Documentation

Allow your users to see their API usage directly in documentationAllow your users to see their API usage directly in documentation

Allow your users to see their API usage directly in documentation

We've found that the best documentation is also the most interactive, so we are also integrating data about your users API usage directly in the developer hubs! Once a user is authenticated, they will be able to see their own API logs directly in the documentation, directly alongside the reference guide for that endpoint.

Read more about API Logs in the Documentation here.

Shareable Logs for Support

Any API log that your users can see can also be shared with your support team. Customers can easily send your support team a URL link to the particular API call that gave them trouble, containing all the context that your team needs to troubleshoot the issue.

What Insights Can API Metrics Provide?

API Metrics is much more than just a list of logs! With the aforementioned API Metrics Dashboard, it's be easier than ever to answer key questions about how people are using your API:

  • Who are your most/least frequent users?
  • Which endpoints or methods are most/least popular?
  • How are your error rates? Which endpoints are causing the most trouble?

With API Metrics, you'll be able to take the answers to these questions and apply them to make much more strategic decisions about your API. Here are a few examples:

  • Unique API users: determine if new or existing customers are fueling API usage and how this changes over time
  • Top API consumers: identify the top users and explore opportunities for upselling or endpoint improvements by observing how these power users interact with the API
  • API pain points: isolate endpoints that are causing the most trouble and identify opportunities for improvement

Did this page help you?