Be the first to get access to new connectors. Get early access →
ConnectorBay Early access

ReadMe Metrics (BYOK) — connector documentation

  • MCP endpoint: https://byok-readme-metrics.connectorbay.com/mcp
  • REST API: POST https://byok-readme-metrics.connectorbay.com/v1/tools/{tool_name}, described by the OpenAPI 3.1 spec at https://byok-readme-metrics.connectorbay.com/openapi.json
  • Transport: Streamable HTTP, stateless, MCP specification 2025-06-18 or later
  • Authentication: your own ReadMe Metrics ReadMe project API key (sent as the basic auth username), sent in the X-Upstream-Key header of every request (never stored, logged or cached)
  • Health: https://byok-readme-metrics.connectorbay.com/health · Tool schemas: https://byok-readme-metrics.connectorbay.com/tools.json
  • Publisher: Unify Dynamics LLC · connectorbay.com/byok-readme-metrics · agent@connectorbay.com

What ReadMe Metrics (BYOK) is for

ReadMe Metrics (BYOK) lets an AI assistant read your own ReadMe Metrics data through the ReadMe Metrics API with a key you supply (ReadMe project API key (sent as the basic auth username)). Read-only: 9 tools (get_total_pageviews, get_unique_pageviews, get_pageview_change, get_pageviews_per_day, get_top_pages, get_top_search_terms, get_average_page_quality, get_best_pages, get_worst_pages). The BYOK key travels with each request, is used for that one call only and is never stored, logged or cached; it is only ever sent to metrics.readme.io. Unofficial connector by Unify Dynamics LLC: not affiliated with, endorsed by or sponsored by ReadMe Metrics. ReadMe Metrics and its logos are trademarks of their owners and are used only to say which service the connector works with.

Ask your assistant things like:

  • "How many page views did my ReadMe docs get this month?"
  • "How many unique page views did my ReadMe docs get recently?"
  • "Are my ReadMe docs getting more page views than before?"
  • "How do my ReadMe page views trend day by day?"
  • "Which ReadMe docs pages are viewed the most?"
  • "What do readers search for in my ReadMe docs?"

What it does

  • get_total_pageviews: Enterprise plan feature of ReadMe. Get the total number of page views in a time window.
  • get_unique_pageviews: Enterprise plan feature of ReadMe. Get the number of unique page views in a time window.
  • get_pageview_change: Enterprise plan feature of ReadMe. Get how total and unique page views changed compared with the previous window.
  • get_pageviews_per_day: Enterprise plan feature of ReadMe. Get page views per time bucket (per day by default) over a window. The API's answer is returned as is.
  • get_top_pages: Enterprise plan feature of ReadMe. List the most viewed documentation pages in a window. The API's answer is returned as is.
  • get_top_search_terms: Enterprise plan feature of ReadMe. List the phrases readers search for most in the docs in a window. The API's answer is returned as is.
  • get_average_page_quality: Enterprise plan feature of ReadMe. Get helpful and total votes per time bucket, optionally for one page path.
  • get_best_pages: Enterprise plan feature of ReadMe. List the pages with the most positive votes: path, total votes, positive votes, difference and average.
  • get_worst_pages: Enterprise plan feature of ReadMe. List the pages with the lowest ratings: path, total votes, positive votes, difference and average.

BYOK key

You bring your own ReadMe Metrics ReadMe project API key (sent as the basic auth username) (https://docs.readme.com/main/reference/authentication). Your assistant sends it in the X-Upstream-Key header with each request. ConnectorBay uses it for that one call only: it is never stored, logged or cached, never shown in an answer, and it is only sent to metrics.readme.io over https, with no redirects followed. Create a key with the fewest permissions the tools need (read-only if the provider offers it), and revoke it at the provider whenever you like.

Data sources

Live from the ReadMe Metrics API (metrics.readme.io) with a BYOK key; documentation: https://docs.readme.com/main/reference/metrics-api-introduction. Endpoints checked against that documentation on 2026-10-16.

What it is not

Unofficial connector by Unify Dynamics LLC: not affiliated with, endorsed by or sponsored by ReadMe Metrics. ReadMe Metrics and its logos are trademarks of their owners and are used only to say which service the connector works with. It is read-only: it never creates, changes, sends or deletes anything in your ReadMe Metrics account.

Built for: Worldwide. Languages: English.