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

Uploaded Source

Built Distribution

readme_metrics-3.3.0-py3-none-any.whl (20.0 kB view details)

Uploaded Python 3

File details

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

File metadata

  • Download URL: readme_metrics-3.3.0.tar.gz
  • Upload date:
  • Size: 16.2 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.3.0.tar.gz
Algorithm Hash digest
SHA256 2c02c2ad0ba8889ec041d4f55c736830866a80bb1d8c90df4b9fa4ad0afe0904
MD5 3ee9e7ff0c7f39928dcc24dd7d9ee324
BLAKE2b-256 d3d55afaa919753861a11dff00a56134e22b48b6b08733824ca20e90a6435ff0

See more details on using hashes here.

File details

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

File metadata

  • Download URL: readme_metrics-3.3.0-py3-none-any.whl
  • Upload date:
  • Size: 20.0 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.3.0-py3-none-any.whl
Algorithm Hash digest
SHA256 296c8aeb0f53149219f946afc9be589cb63359eb7476fff0512363a40b5ef5f8
MD5 4267f88a223a3b85989edbfc7ca966d3
BLAKE2b-256 9fb17b79f81e281e7628f8e3b03b0cc4ed38c1fe7a2209ffc714ef6b76fbf4ed

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