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

Showing API Logs in Documentation

This requires API Metrics

You can learn more about setting up API Metrics here

Overview

Your users can view their logs directly in the API Explorer

Your users can view their logs directly in the API Explorer

Once you start sending your API logs to ReadMe, you can also show those logs to authenticated users! Logs will show up in both the Reference section, and in a Logs section.

In the API Explorer, users will see their logs for each endpoint alongside the documentation, so they can easily compare their usage with the documentation on what they should be passing in.

Logs section showing all of the API calls a user has made

Logs section showing all of the API calls a user has made

There is also a Logs section where the user will see all of their API calls for all endpoints. There, they can filter by status, method, or endpoint.

Enabling API logs in docs

Follow these steps to enable users to see their own API logs in the docs:

  1. Send your API logs to ReadMe.

Scrub your API logs of confidential information before sending to ReadMe

API logs are viewable by anyone with ReadMe admin privileges. You can find out how to remove secure information from the logs at Sending API Logs to ReadMe.

  1. You need to set up an authentication method to connect the user logged in with ReadMe with specific logs. ReadMe supports logging in with JWT, which you can set up with this guide.

All you need to do is pass in an id with the user that matches the id for a log. Then that user will be able to see all of the matching logs.

Need help getting this setup? Send us an email at [email protected].

Updated 4 days ago


Showing API Logs in Documentation


Suggested Edits are limited on API Reference Pages

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