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

Uploaded Source

Built Distribution

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

Uploaded Python 3

File details

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

File metadata

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

File hashes

Hashes for readme-metrics-2.2.1.tar.gz
Algorithm Hash digest
SHA256 0b0317bcfcac0c27f3dfdcae3071fea57684f1e125bf816c2c601a13a74e2397
MD5 d2c6b7efa870677aca0dd164325ae644
BLAKE2b-256 ed273dc20f89b4b0d11fb57e3058cc5f64ffa144244897726239479380cf6cbc

See more details on using hashes here.

File details

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

File metadata

File hashes

Hashes for readme_metrics-2.2.1-py3-none-any.whl
Algorithm Hash digest
SHA256 e1dddb8ad8b6cdbb2de6c6a6438f1566cbf61dd256d2bcfbc98e13725c75d10a
MD5 9c5730cfa2dec7316964fbd2af810e99
BLAKE2b-256 40d840f90529a5529c83d2e26e55d6786c94852f8ba01d1d0862662a9ea9ef16

See more details on using hashes here.

Supported by

AWS AWS Cloud computing and Security Sponsor Datadog Datadog Monitoring Fastly Fastly CDN Google Google Download Analytics Pingdom Pingdom Monitoring Sentry Sentry Error logging StatusPage StatusPage Status page