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

Uploaded Source

Built Distribution

readme_metrics-2.2.2-py3-none-any.whl (16.4 kB view details)

Uploaded Python 3

File details

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

File metadata

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

File hashes

Hashes for readme-metrics-2.2.2.tar.gz
Algorithm Hash digest
SHA256 7265134eb57144043b0e8c78e1ae7388db163ec2c5974ced98a421587be4b312
MD5 2c93815e1992a84adf9b6ac6c0ef78d5
BLAKE2b-256 a98305955f6534f98bb3c73c84102fe7ba59f473fb51601eedf1a639e6bc9c3e

See more details on using hashes here.

File details

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

File metadata

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

File hashes

Hashes for readme_metrics-2.2.2-py3-none-any.whl
Algorithm Hash digest
SHA256 378f4bd89642fbd01f4fef01978c653f7f7519b7f1d4d788d003601d0f3a2926
MD5 cf03d943251b2913eb49552dc65975fb
BLAKE2b-256 81e80ab823c4e8f4a2bfc7ccede0313beecb7b6db15e7f011be6f90704b01c13

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