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

Uploaded Source

Built Distribution

readme_metrics-2.1.0-py3-none-any.whl (15.8 kB view details)

Uploaded Python 3

File details

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

File metadata

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

File hashes

Hashes for readme-metrics-2.1.0.tar.gz
Algorithm Hash digest
SHA256 38153ea5eeb0f8c39affc442f51410531ec66bf348ffdb9299bdf9bdecf14b8c
MD5 0de5725362d0aac8b1671cddc01c4639
BLAKE2b-256 0cca596abaaaecdf673f9fc5fce6d58d5f88c551bd31e5181430d2dc3fc0b581

See more details on using hashes here.

File details

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

File metadata

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

File hashes

Hashes for readme_metrics-2.1.0-py3-none-any.whl
Algorithm Hash digest
SHA256 9ab3a58d77eda08637a4c96c04516334db1b619f1288b4355a0017c90cfa3ff4
MD5 6e484e68d27332239b7d74e7c1ce202c
BLAKE2b-256 f6e593f28d66189d9d4f5151c94dd7f13aeb741ec96c7cb7b2560476134c254e

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