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.0.0.tar.gz (13.7 kB view details)

Uploaded Source

Built Distribution

readme_metrics-3.0.0-py3-none-any.whl (16.5 kB view details)

Uploaded Python 3

File details

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

File metadata

  • Download URL: readme-metrics-3.0.0.tar.gz
  • Upload date:
  • Size: 13.7 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.0.0.tar.gz
Algorithm Hash digest
SHA256 7e7e1bc9ce8451e12d0764762e5f683108ada4e7fb6e1385a678d0d9617fe95a
MD5 2663b0bb271750f879018a2013c6768d
BLAKE2b-256 6f2d709d7413755ef7a48d58c4ba9f245f9c6649eebed3f886b7b127a877db67

See more details on using hashes here.

File details

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

File metadata

  • Download URL: readme_metrics-3.0.0-py3-none-any.whl
  • Upload date:
  • Size: 16.5 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/4.0.1 CPython/3.10.10

File hashes

Hashes for readme_metrics-3.0.0-py3-none-any.whl
Algorithm Hash digest
SHA256 2521535bba6e412e3455f8d9ece8abff3105263f5c3b74a08b975c8ac859f4da
MD5 bca729ca77c2091cd9257de56da80202
BLAKE2b-256 a60ce619244a07f5c1a5faabd8099aef6767a6b99bb928adc1a418234d20b543

See more details on using hashes here.

Supported by

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