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

Uploaded Source

Built Distribution

readme_metrics-3.2.0-py3-none-any.whl (18.9 kB view details)

Uploaded Python 3

File details

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

File metadata

  • Download URL: readme_metrics-3.2.0.tar.gz
  • Upload date:
  • Size: 15.5 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.2.0.tar.gz
Algorithm Hash digest
SHA256 ee9e7565d58399fba4053eac185ecb05c6ae6bb0cf005aae29f99aafede0768d
MD5 6fefc479f6956c67eb30c173b6a54d8f
BLAKE2b-256 da95b621c948c7dcf01a25ecfd0a06988336e1c85de301a8002c416e22e44f85

See more details on using hashes here.

File details

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

File metadata

  • Download URL: readme_metrics-3.2.0-py3-none-any.whl
  • Upload date:
  • Size: 18.9 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.2.0-py3-none-any.whl
Algorithm Hash digest
SHA256 71acb2e489d9f45e578d59c04c75f0a345afd3d76bc7e12a7b9dd5aa9edc9fce
MD5 c6fd02ded5d8da138a81a897b888fcc8
BLAKE2b-256 6730f812a987c3c6409b165709b0e8df24042a4f2fe3bb6e60f399f3f9bed284

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