ReadMe Metrics

ReadMe is an API documentation and developer hub platform that helps companies build interactive API documentation, track API usage analytics, and improve developer experience. ReadMe Metrics captures and analyzes API request logs to provide insights into how developers are using your APIs.

2 APIs 0 Features

API AnalyticsAPI DocumentationAPI LogsAPI MetricsAPI UsageDeveloper ExperienceDeveloper Hubs

APIs

ReadMe API

The ReadMe API allows you to programmatically manage your ReadMe developer hub, including API definitions, documentation pages, changelogs, custom pages, categories, and API usa...

ReadMe Metrics

ReadMe Metrics captures and analyzes API request and response data to provide usage analytics, error tracking, and developer activity insights. It helps API providers understand...

Collections

ReadMe API

OPEN

Pricing Plans

Readme Metrics Plans Pricing

3 plans

PLANS

Rate Limits

Readme Metrics Rate Limits

5 limits

RATE LIMITS

FinOps

Readme Metrics Finops

FINOPS

Resources

DomainSecurity

Authentication

Documentation

Sources

opencollection: 1.0.0
info:
  name: ReadMe API
  version: 1.0.0
request:
  auth:
    type: basic
    username: '{{username}}'
    password: '{{password}}'
items:
- info:
    name: List API specifications
    type: http
  http:
    method: GET
    url: https://dash.readme.com/api/v1/api-specification
    headers:
    - name: x-readme-version
      value: ''
    params:
    - name: perPage
      value: ''
      type: query
      description: Items per page (max 100).
    - name: page
      value: ''
      type: query
      description: Page number (1-based).
  docs: List API specifications
- info:
    name: Upload an API specification
    type: http
  http:
    method: POST
    url: https://dash.readme.com/api/v1/api-specification
    headers:
    - name: x-readme-version
      value: ''
    body:
      type: multipart-form
      data:
      - name: spec
        type: text
        value: ''
      - name: url
        type: text
        value: ''
  docs: Upload an API specification
- info:
    name: Get an API registry entry
    type: http
  http:
    method: GET
    url: https://dash.readme.com/api/v1/api-registry/:uuid
    params:
    - name: uuid
      value: ''
      type: path
  docs: Get an API registry entry
- info:
    name: List changelogs
    type: http
  http:
    method: GET
    url: https://dash.readme.com/api/v1/changelogs
    params:
    - name: perPage
      value: ''
      type: query
      description: Items per page (max 100).
    - name: page
      value: ''
      type: query
      description: Page number (1-based).
  docs: List changelogs
- info:
    name: Get a documentation page
    type: http
  http:
    method: GET
    url: https://dash.readme.com/api/v1/docs/:slug
    headers:
    - name: x-readme-version
      value: ''
    params:
    - name: slug
      value: ''
      type: path
  docs: Get a documentation page
bundled: true