Skip to main content

ReadMe Metrics

Track usage of your API and troubleshoot issues faster.

Latest release Build status

With ReadMe's Metrics API your team can get deep insights into your API's usage. If you're a developer, it takes a few small steps to send your API logs to ReadMe. Here's an overview of how the integration works:

  • You add the ReadMe middleware to your Django, Flask, or WSGI application.
  • The middleware sends to ReadMe the response object that your application generates each time a user makes a request to your API. The entire response is sent, unless you allow or deny keys.
  • ReadMe populates Metrics with this information, such as which endpoint is being called, response code, and error messages. It also identifies the customer who called your API, using whichever keys in the middleware you call out as containing relevant customer info.
pip install "readme-metrics[Django]" # Django applications
pip install "readme-metrics[Flask]" # Flask applications
pip install readme-metrics # WSGI

🚧 Any Issues?

Integrations can be tricky! Contact support if you have any questions/issues.

Metadata

Release files for readme-metrics 3.4.0

For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.

Source distribution (sdist)

Source distribution for readme-metrics 3.4.0
File Size Uploaded Provenance
readme_metrics-3.4.0.tar.gz 16.4 kB Without provenance Details

Built distribution (wheel)

Table of built distributions (wheels) for readme-metrics 3.4.0
File Interpreter ABI Platform
readme_metrics-3.4.0-py3-none-any.whl Python 3 none any Details

Total release size: 36.6 kB

Release files / readme_metrics-3.4.0.tar.gz

Download URL readme_metrics-3.4.0.tar.gz
Size 16.4 kB
Tags Source
SHA-256 checksum
How to use checksums
036c784b9943bf4a4d263b544a79d929b4c4ca87df3b69303229e7aae235e7c1
BLAKE2b-256 checksum
How to use checksums
c381576a248e110abcde3f232f0cd5f7b7d127327e0115772ca62d11683bb369
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
No
Uploaded via twine/6.0.1 CPython/3.13.1

Release files / readme_metrics-3.4.0-py3-none-any.whl

Download URL readme_metrics-3.4.0-py3-none-any.whl
Size 20.2 kB
Tags Python 3
SHA-256 checksum
How to use checksums
dd6f397541b3e3587fe30791e10743f1fb4ad2fd57386c72ad6a3e3ccb419a31
BLAKE2b-256 checksum
How to use checksums
7826c2e577a6d0d0df915650b19097becaa8f5f3bea8aa530fb876035f362157
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
No
Uploaded via twine/6.0.1 CPython/3.13.1

Security for readme-metrics 3.4.0

Provenance

Provenance describes where a file came from. On PyPI, provenance is shared via attestations, which provide a verifiable record of the build or publishing details. View details, limitations and caveats.

No provenance found

None of the files in this release were uploaded with provenance metadata.

A note on package security

PyPI is a repository for distributing packages, not a service for auditing them. While third-party security researchers and our staff do their best to detect and remove malicious packages, PyPI cannot guarantee the quality, security or suitability of any given package.

Anthropic, PBC Visionary sponsor Bloomberg Visionary sponsor Hudson River Trading Visionary sponsor Meta Visionary sponsor NVIDIA Visionary sponsor Microsoft Sustainability sponsor Depot Continuous Integration AWS Cloud computing and Security Sponsor Datadog Monitoring Fastly CDN Google Download Analytics Sentry Error logging StatusPage Status page