Skip to main content

ReadMe API Metrics SDK

Project description

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.

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

readme-metrics-3.1.0.tar.gz (15.1 kB view details)

Uploaded Source

Built Distribution

readme_metrics-3.1.0-py3-none-any.whl (18.3 kB view details)

Uploaded Python 3

File details

Details for the file readme-metrics-3.1.0.tar.gz.

File metadata

  • Download URL: readme-metrics-3.1.0.tar.gz
  • Upload date:
  • Size: 15.1 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/4.0.1 CPython/3.10.10

File hashes

Hashes for readme-metrics-3.1.0.tar.gz
Algorithm Hash digest
SHA256 c736477acaf0ce015bca4dbe22cd8a4e64642f131127888f90783a5c12ea89eb
MD5 2b644562bfb504ad426e350139537c04
BLAKE2b-256 35a350932e1cdbd3e6c5bfa7263b6ef15c8c7485a81d715533106764110fed1f

See more details on using hashes here.

File details

Details for the file readme_metrics-3.1.0-py3-none-any.whl.

File metadata

File hashes

Hashes for readme_metrics-3.1.0-py3-none-any.whl
Algorithm Hash digest
SHA256 2c1fbc538483700a9abef132d264218903b50cd437cb8685d4864ca26db1441c
MD5 9eede297465ce77507cfe3ca0d2f76bf
BLAKE2b-256 6d3b6038377f7cc41a59b5ba6b832dcbc15c75542adb8a28728d0b52f8ddb505

See more details on using hashes here.

Supported by

AWS AWS Cloud computing and Security Sponsor Datadog Datadog Monitoring Fastly Fastly CDN Google Google Download Analytics Microsoft Microsoft PSF Sponsor Pingdom Pingdom Monitoring Sentry Sentry Error logging StatusPage StatusPage Status page