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

Uploaded Source

Built Distribution

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

Uploaded Python 3

File details

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

File metadata

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

File hashes

Hashes for readme-metrics-3.0.3.tar.gz
Algorithm Hash digest
SHA256 2dff3ff7f9320438b767e93d30fd3f6a2e3068c57b2ab3801e89f890d3c65e2b
MD5 9f60b39206fd47e17e808e623cb11be7
BLAKE2b-256 2d64363be91b2bad2f1f903b91fe34cf395c5ed7fdd50be8b5479ceedb4f2ce6

See more details on using hashes here.

File details

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

File metadata

File hashes

Hashes for readme_metrics-3.0.3-py3-none-any.whl
Algorithm Hash digest
SHA256 b0b9f268133f503ca365cabb8fd36c149b3d7bd1987e31793d275e1010f536eb
MD5 5b6a0ddc961ef2ad835f64dc40836d9d
BLAKE2b-256 130bd21eb6534db7e31b7c70f39245a5ede43a10f0928852c7e465a94d68c40c

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