Getting Started With Metrics

:rocket: We're in the process of rolling out the new Metrics experience for all customers. This will be live in your project in the coming weeks! Go here for docs on our legacy Metrics product.

Meet Metrics

β€œIf you build it, they will come.” It’s a classic trap that most SaaS companies have moved beyond today. They understand that even the best product in the world needs a great customer experience, marketing, and roadmap to succeed.

So why do we think that APIs are so different? Today, many teams pour months of engineering time into building great APIs β€” and then only post an API Reference to publicize it and move on. If you build it, they will call it… right?

At ReadMe, we’ve seen the power of what great developer hubs can do for adoption. They make your APIs easier to use, educate users on how to get started, and let them try things out for themselves in real time. But how do you know if your hub is really working? That's where Metrics comes in. It gives you visibility into KPIs like API usage over time, hub activity like page views and voting , and even API errors so you can see where developers are getting stuck and reach out to help.

Where To Start

Data is only useful if it's actionable, so here are a few questions to think about when looking at your Metrics data. These are what we hear most from our customers who own API adoption and developer success, but we'd love to hear what's most helpful to you!

πŸš€ How is my API growing and performing?

  • Total Calls + Errors + Compare History

πŸ‘‹ Who’s using my API?

  • New Users: Feed
  • Biggest Users: API Calls grouped by User

πŸ† What are my best API use cases?

  • Endpoints (usage) + Page Views (what they’re reading)

πŸ›€ Are my docs getting users on the right track?

  • Searches + Page Views + Page Quality
  • Errors over time

πŸ‘

Metrics + Developer Support Workflow

In addition to longer term platform strategy and developer experience, Metrics is really helpful for improving day-to-day developer support, too. Here are a few ways to leverage Metrics in your support workflow!

  • Quickly catch spikes in errors at a glance
  • Shareable request logs ensure everyone is on the same page
  • Filter for API calls for a specific user to dig into an issue
  • Users can see all their past requests directly in the hub for easy debugging

Using Metrics Charts

History

Tracking trends over time is a key way to measure the impact of improvements and new API features. Based on your ReadMe plan, you'll have access to a certain amount of data history. Toggle between them in the upper right corner to drill down on usage spikes or dips, pull metrics for quarterly or annual planning cycles, or see how much variability you have week to week.

Filters

Dial into the answers you're looking for with filters specific to each chart to show, hide, or group the underlying data. These allow you to create custom views for the particular question you're investigating like breaking down API usage by method or tracking negative page votes over time.

Chart Type & Compare

For every chart, you can switch between line and bar charts to get the view of your data that's most helpful to you. Click the toggle to compare your data to the prior period (based on your chosen History window) to track trends over time.

Shortcuts

Think of these as ReadMe pro tips β€” we've put together one-click shortcuts to popular filter and history settings that answer the most common questions platform teams have about their hubs and API usage. Just check the bottom of each chart!

Pricing FAQ

All Metrics charts and functionality are included in your core ReadMe plan β€” so analyze away! Here are the two key differences across plans:

History

Your data history toggle will be limited to Day, Week, and Month for Free customers. As you move up plans, you will unlock additional history so you can track trends over time.

  • Free: 30 days (Day, Week, Month)
  • Startup: 90 days (Day, Week, Month, Quarter)
  • Business: 1 year (Day, Week, Month, Quarter, Year)
  • Enterprise: Custom

Included API Requests

Some charts and functionality depend on sending API request data to ReadMe, like monitoring API usage and errors or showing API request history to authenticated users in your hub. Each plan has a certain amount of included API requests per month:

  • Free: 1M requests per month
  • Startup: 2M requests per month
  • Business: 5M requests per month
  • Enterprise: 20M requests per month

Adding more API requests is completely optional! We won't automatically charge you for more requests even if you're at your plan's included limit for the month. If you'd like to keep using Metrics beyond that limit, you can upgrade your plan to the next tier (e.g. Free ➑️ Startup or Startup ➑️ Business), or add more API requests in blocks of $100 per 1M requests.


Did this page help you?