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

Uploaded Source

Built Distribution

readme_metrics-3.4.0-py3-none-any.whl (20.2 kB view details)

Uploaded Python 3

File details

Details for the file readme_metrics-3.4.0.tar.gz.

File metadata

  • Download URL: readme_metrics-3.4.0.tar.gz
  • Upload date:
  • Size: 16.4 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.0.1 CPython/3.13.1

File hashes

Hashes for readme_metrics-3.4.0.tar.gz
Algorithm Hash digest
SHA256 036c784b9943bf4a4d263b544a79d929b4c4ca87df3b69303229e7aae235e7c1
MD5 f978ce699553c2b66bd23b2ac19979eb
BLAKE2b-256 c381576a248e110abcde3f232f0cd5f7b7d127327e0115772ca62d11683bb369

See more details on using hashes here.

File details

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

File metadata

  • Download URL: readme_metrics-3.4.0-py3-none-any.whl
  • Upload date:
  • Size: 20.2 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.0.1 CPython/3.13.1

File hashes

Hashes for readme_metrics-3.4.0-py3-none-any.whl
Algorithm Hash digest
SHA256 dd6f397541b3e3587fe30791e10743f1fb4ad2fd57386c72ad6a3e3ccb419a31
MD5 6ebe322627d6cb7a214dec2d44671636
BLAKE2b-256 7826c2e577a6d0d0df915650b19097becaa8f5f3bea8aa530fb876035f362157

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