ReadMe Metrics API
Send API request metrics from server-side SDKs
ReadMe Metrics API is one of 14 APIs that ReadMe publishes on the APIs.io network, described by a machine-readable OpenAPI specification.
Tagged areas include Metrics. The published artifact set on APIs.io includes an OpenAPI specification, API documentation, and authentication docs.
This API exposes 1 operation across 1 path, and defines 1 schema. It is described by OpenAPI 3.1.0, at version 1.0.
Requests are made against a single base URL, https://metrics.readme.io/v1.
Metadata
The identity and technical contract details declared by the specification.
Authentication & Security 1
ReadMe Metrics API declares
1 security scheme
for authenticating requests.
It accepts HTTP basic authentication (basicAuth).
By default, every request must be authenticated.
basicAuth— HTTP Basic auth using your ReadMe API key as the username (password blank).
Paths & Operations 1
Across 1 path, the API surfaces 1 operation — 1 POST. Each is listed below with its method, path, parameters, and response codes.
Send API request metrics from server-side SDKs
Schemas 1
The contract defines 1 schema that model the data the API accepts and returns. The most detailed is MetricsRequest (6 properties). Each schema is shown below with its type and property counts.
Specification
The full machine-readable OpenAPI contract behind this narrative.
Source
More from ReadMe 12
Other APIs ReadMe publishes across the network.