See how people use your docs and how developers use your API

🚧

Enterprise Only

Getting metrics data via our API is only available on our Enterprise Plan. Contact [email protected] if you are interested!

The Metrics API gives you access to:

  • API Metrics, which show how people user your API
  • Documentation Metrics, which show how people use your docs.

Many of the metrics that you can get using this API are also available as visualizations on either the API Metrics dashboard or the Documentation Metrics dashboard.

Authentication

You'll use your doc project's API key for the Metrics API.
For more information about using this key, see https://docs.readme.com/developers/docs/authentication.

Endpoints overview

API Explorer

Use these endpoints to see metrics about calls that authenticated users made to your API via the Try It buttons in your API explorer (e.g., your interactive API reference). It doesn't return metrics for calls users made to your API made via other methods, for example, command-line cURL.

Companies

Use these endpoints to identify leads by learning about companies that are visiting your docs. Powered by Clearbit. Leads are also available on the Project Metrics dashboard at dash.readme.io/project/yourProject/metrics/project.

Page Views

Use these endpoints to see metrics about your most frequently viewed documentation. Several of these metrics are also available on the Project Metrics dashboard at dash.readme.io/project/yourProject/metrics/project.

API Logs

Use these endpoints to integrate your API with Developer Metrics in ReadMe.

Search

Use this endpoint to see the top terms your users are searching for in your docs. This information is also available on the Project Metrics dashboard at dash.readme.io/project/yourProject/metrics/project.

Thumb Vote

Use this endpoint to see which documentation pages your users voted as being helpful or not. This information is also available on the Project Metrics dashboard at dash.readme.io/project/yourProject/metrics/project.