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

The API Metrics Dashboard

The API Metrics Dashboard gives your ReadMe project administrators the ability to segment your APIs logs by response status code, endpoint, request method, user or any combination of those four filters.

After you set up API Metrics (see Getting Started With API Metrics), you can view the API Metrics Dashboard at dash.readme.io/project/yourProject/vcurrentVersion/metrics/overview.

There are three overall sections of the dashboard:

  1. Search/Filter Bar
  2. Overview Cards
  3. Detailed Logs

Search/Filter Bar

Select one or any combination of the following categories to segment the logs.

  • HTTP Response Status Code
  • Endpoint
  • HTTP Request Method (GET, PUT, POST, DELETE, etc.)
  • User

To use the search bar, select a category and type in a search term. The results of the filtered segment will appear in the overview cards and detailed log.

Note that "User" is defined depending on how you identify your own API users in your database. So, a "user" may refer to one person or a group of people using a single API key, for example. You configure the user's identifier and label when you set up API Metrics.

Overview Cards

The three cards display the following information based on the currently filtered segment:

  1. Top Metrics — Users and Endpoints with the highest API usage
  2. Status Codes — Pie chart and list overviews of HTTP response status codes
  3. Usage Metrics — Total Calls, Total Users, Average Response Time, Average Calls Per Project

What Can You Do with This Information?

With these overview cards, you can get answers to many important questions about your API usage at a glance:

  • Who are my most/least frequent users?
  • How are my endpoints performing overall?
  • Which users are having troubles?
  • Which endpoints are causing troubles?

Read more about the insights that API Metrics can provide here.

Detailed Log

Based on the currently filtered segment, you have access to the full list of logs for every call made to your API. At a glance, you'll be able to see the following information in your full list of logs:

  • Request Method
  • Response Status Code
  • Endpoint
  • User (this will be whatever you send in to label/identify your users when configuring API Metrics)
  • User Agent (i.e. info about the user's browser, operating system, application, etc.)
  • Timestamp

When you click on individual logs, you'll be able to see additional details:

  • Request Headers
  • Response Headers
  • Response Body

What Can You Do with This Information?

With the ability to view detailed logs about your API usage and see exactly what customers send you and what you're sending back, troubleshooting issues will be a breeze.

Updated 6 months ago



The API Metrics Dashboard


Suggested Edits are limited on API Reference Pages

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