Skip to main content

Monitoring and analytics for FastAPI applications.

Project description

FastAPI 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.

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"}

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

fastapi-analytics-1.0.8.tar.gz (40.2 kB view details)

Uploaded Source

Built Distribution

fastapi_analytics-1.0.8-py3-none-any.whl (28.2 kB view details)

Uploaded Python 3

File details

Details for the file fastapi-analytics-1.0.8.tar.gz.

File metadata

  • Download URL: fastapi-analytics-1.0.8.tar.gz
  • Upload date:
  • Size: 40.2 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 fastapi-analytics-1.0.8.tar.gz
Algorithm Hash digest
SHA256 b292689b9717bf8ecaa9ed97935179fa56ffcea3c0ce05381fb492758f342ae2
MD5 b3681e65d12f6bcc8a47c9fb984f3d10
BLAKE2b-256 838b896abfe8233b78f82e7c9b55260ac4e40ebff1aae62ef77179db87445e71

See more details on using hashes here.

Provenance

File details

Details for the file fastapi_analytics-1.0.8-py3-none-any.whl.

File metadata

  • Download URL: fastapi_analytics-1.0.8-py3-none-any.whl
  • Upload date:
  • Size: 28.2 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 fastapi_analytics-1.0.8-py3-none-any.whl
Algorithm Hash digest
SHA256 6c3fab2793f87028c64e7afb0e2012b74c9561a07e6a49b21939a482a5c84572
MD5 10c7d8369b53651dabbf24c637fb01d3
BLAKE2b-256 210a07a5ebe8fb0caae180fc757a33ab69fbc456582ff2275d078da741384f3e

See more details on using hashes here.

Provenance

Supported by

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