Skip to main content

Monitoring and analytics for Python API frameworks.

Project description

API Analytics

A lightweight API analytics solution, complete with a dashboard.

Getting Started

1. Generate a new API key

Head to https://my-api-analytics.vercel.app/generate to generate your unique API key with a single click. This key is used to monitor your specific API, so keep it secret! It's also required in order to view your APIs analytics dashboard.

2. Add middleware to your API

Add our lightweight middleware to your API. Almost all processing is handled by our servers so there should be virtually no impact on your APIs performance.

FastAPI

python -m pip install api-analytics
from fastapi import FastAPI
from api_analytics.fastapi import Analytics

app = FastAPI()
app.add_middleware(Analytics, <api_key>)

@app.get("/")
async def root():
    return {"message": "Hello World"}

Flask

python -m pip install api-analytics
from flask import Flask
from api_analytics.flask import add_middleware

app = Flask(__name__)
add_middleware(app, <api_key>)

@app.get("/")
def root():
    return {"message": "Hello World"}

3. View your analytics

Your API will log requests on all valid routes. Head over to https://my-api-analytics.vercel.app/dashboard and paste in your API key to view your dashboard.

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

api-analytics-1.0.4.tar.gz (40.5 kB view details)

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

api_analytics-1.0.4-py3-none-any.whl (28.8 kB view details)

Uploaded Python 3

File details

Details for the file api-analytics-1.0.4.tar.gz.

File metadata

  • Download URL: api-analytics-1.0.4.tar.gz
  • Upload date:
  • Size: 40.5 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/3.8.0 pkginfo/1.8.3 readme-renderer/37.3 requests/2.27.1 requests-toolbelt/0.10.1 urllib3/1.26.9 tqdm/4.64.0 importlib-metadata/5.0.0 keyring/23.9.3 rfc3986/1.5.0 colorama/0.4.4 CPython/3.10.6

File hashes

Hashes for api-analytics-1.0.4.tar.gz
Algorithm Hash digest
SHA256 b2e43992fcb94900a57f483877c4eeacd197d7cde7994abee81e9f496fae0640
MD5 04d0e13e8538067fe2a0f772aa42a3ea
BLAKE2b-256 aae8717d1a0af1669c2bf7b0eeebe43f22b59becbe709f0f12030b5c1ca96d2d

See more details on using hashes here.

File details

Details for the file api_analytics-1.0.4-py3-none-any.whl.

File metadata

  • Download URL: api_analytics-1.0.4-py3-none-any.whl
  • Upload date:
  • Size: 28.8 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/3.8.0 pkginfo/1.8.3 readme-renderer/37.3 requests/2.27.1 requests-toolbelt/0.10.1 urllib3/1.26.9 tqdm/4.64.0 importlib-metadata/5.0.0 keyring/23.9.3 rfc3986/1.5.0 colorama/0.4.4 CPython/3.10.6

File hashes

Hashes for api_analytics-1.0.4-py3-none-any.whl
Algorithm Hash digest
SHA256 34987b1b6adb8ae15f1c59ce36972a4bf6c670c6145fc2362d3e072cea681711
MD5 b862f7ae5bc50e76b056cd1349ed860a
BLAKE2b-256 f64bd0365c661d6b5ba9b0a802a61235419616486493bb5d5c90ead4e381e75f

See more details on using hashes here.

Supported by

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