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

Uploaded Source

Built Distribution

readme_metrics-3.0.1-py3-none-any.whl (17.2 kB view details)

Uploaded Python 3

File details

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

File metadata

  • Download URL: readme-metrics-3.0.1.tar.gz
  • Upload date:
  • Size: 14.4 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/4.0.2 CPython/3.11.4

File hashes

Hashes for readme-metrics-3.0.1.tar.gz
Algorithm Hash digest
SHA256 a136da23a81fb1bae2da4a2cc90f71439eafaa27ad40df51380d962a837dec76
MD5 aa25f157261a2be45bbdce06f397c3ad
BLAKE2b-256 ab09c568d22460bb186c0ed6797734c54a7c6d6f9269a310752a40f5da4505c4

See more details on using hashes here.

File details

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

File metadata

  • Download URL: readme_metrics-3.0.1-py3-none-any.whl
  • Upload date:
  • Size: 17.2 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/4.0.2 CPython/3.11.4

File hashes

Hashes for readme_metrics-3.0.1-py3-none-any.whl
Algorithm Hash digest
SHA256 3289e3fea117fa4dc1b6fcb08ce7fe7d30f6a214ba963c1756278cd2eafe28d8
MD5 b19ca7d479b054e4efaa1a8a08eeb258
BLAKE2b-256 ccb9c47b2be4ca57c6bcf94c08dc76b3b31da9525c667a6514ac019a1dba6d44

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