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

Uploaded Source

Built Distribution

readme_metrics-3.0.2-py3-none-any.whl (17.3 kB view details)

Uploaded Python 3

File details

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

File metadata

  • Download URL: readme-metrics-3.0.2.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.2.tar.gz
Algorithm Hash digest
SHA256 693ef3d985bdab906a4d7a11a8341584f3f3cfde938bd6ab37ecaa75976371bc
MD5 f3126e9a1947996258171485e6a04bba
BLAKE2b-256 fa13ede20cadcd9341a582563271506f0fde88b93bf7c1f5aff5a6a93e2b9a93

See more details on using hashes here.

File details

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

File metadata

  • Download URL: readme_metrics-3.0.2-py3-none-any.whl
  • Upload date:
  • Size: 17.3 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.2-py3-none-any.whl
Algorithm Hash digest
SHA256 2eb3c8e5241d4faaad97027355010e6dab8a5c04c42dfa42fa268bccd9d952ce
MD5 c7df1239e0addf16b0e3806a4cb4e472
BLAKE2b-256 6a112c5866b969b716d3ff7123b7f4fff4d37bdf6eaf7e0eb216727c4ea0c2cc

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