Send API Request Data to ReadMe

: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.

In order to report on how developers are using your API, you need to integrate with ReadMe by sending your API request data to ReadMe. ReadMe receives your raw request/response data, processes them, and displays them in relevant Metrics charts like API Calls, API Errors, and Endpoints in your project dashboard. Authenticated users of your docs will also be able to access their API request history directly from your API reference for quick debugging.

Supported integrations

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

  • If you are using Node.js (Express.js), PHP (Laravel), or Python (WSGI) (with more to come!) 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 requests directly to ReadMe via our Metrics API. You can read the Metrics API docs here.

Security

API requests sent to ReadMe show up in your dashboard, so anyone with administrative access to your ReadMe project can view them. API users can also see past requests in the history widget of your API reference, if you implemented a custom login.

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

  • If you send request data to ReadMe via PHP or Node, you can whitelist or blacklist certain parts of the API request. If you send request data via Cloudflare, you can't currently whitelist/blacklist.

  • If you're sending request data via the Metrics API, clean your data before sending it to the API, so confidential data never gets to ReadMe.


Did this page help you?