Developer Metrics

ReadMe Documentation

Welcome to the ReadMe Documentation, where you'll find comprehensive guides and community support to help you start working with ReadMe as quickly as possible!

Get Started

Getting Started With API Metrics

In order to see metrics about how developers are using your API, you need to integrate with ReadMe by sending your API calls to ReadMe. ReadMe receives your raw request/response data, processes them, and displays them in the API Metrics Dashboard and in your documentation.

Supported integrations

We currently support the following mechanisms for sending API logs to ReadMe:

  • If you are using Node.js (Express.js) or PHP (Laravel) for your API, you can integrate our middleware in your code.

  • If your API is behind CloudFlare, we have an integration with CloudFlare that is language agnostic. With just a little setup it will automatically forward the details of any requests to ReadMe.

Many more integrations will be coming soon! If you don't want to wait, but your API gateway or language isn't currently supported, then you can send API Logs directly to ReadMe via our Metrics API. You can read the full docs here.

Security

API logs sent to ReadMe show up in the API Metrics dashboard, so anyone with administrative access to your ReadMe project can view them. API users can also see the logs they generate in the API documentation, if you implemented a custom login.

Therefore, it's a good idea to omit sensitive or confidential information when you send logs to ReadMe. You can configure this as follows:

  • You can whitelist or blacklist which parts of the API logs to send, if you send logs to ReadMe via PHP or Node. If you send logs via Cloudflare, you can't currently whitelist/blacklist.

  • If you're sending logs via the Metrics API, then you need to clean the data down before you send it to the API so confidential data never gets to ReadMe.

Updated 3 months ago



Getting Started With API Metrics


Suggested Edits are limited on API Reference Pages

You can only suggest edits to Markdown body content, but not to the API spec.