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

Uploaded Source

Built Distribution

readme_metrics-2.2.3-py3-none-any.whl (16.5 kB view details)

Uploaded Python 3

File details

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

File metadata

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

File hashes

Hashes for readme-metrics-2.2.3.tar.gz
Algorithm Hash digest
SHA256 39eb786b4eb166e0e190634e1bf28cc7f1c81805115c9d557e6630f36459a1be
MD5 c694dece33dd153b8954d2d8e867eebc
BLAKE2b-256 b3f215b599300131f5783993b4e84764cecf76ab0502aeaee6ad8e86cd2ef952

See more details on using hashes here.

File details

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

File metadata

  • Download URL: readme_metrics-2.2.3-py3-none-any.whl
  • Upload date:
  • Size: 16.5 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/4.0.1 CPython/3.10.10

File hashes

Hashes for readme_metrics-2.2.3-py3-none-any.whl
Algorithm Hash digest
SHA256 2ff0bbf7e99413a68434d029fe5774128c01a47bf21dd74f25e60cf667c52531
MD5 3156d06675caa849bb35326f540b502c
BLAKE2b-256 75f7144ac40aaf1909ac5745708676636651a38f3cfb032bf5eaceb5d0bd94fa

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