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.
If your API utilizes Node.js (Express.js), PHP (Laravel), or Python (WSGI), our middleware can be integrated with your code!
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.
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 one of our language-based SDKs, you can allow or disallow certain parts of the API request.
If you're sending data to us via our Try-It-Now functionality in your reference section, we don't currently support a way to allow/disallow information. This functionality is coming soon!
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.
Updated 7 months ago