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.

pip install fastapi-analytics
from fastapi import FastAPI
from fastapi_analytics.fastapi import Analytics

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

@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.13.tar.gz (3.7 kB view details)

Uploaded Source

Built Distribution

fastapi_analytics-1.0.13-py3-none-any.whl (4.6 kB view details)

Uploaded Python 3

File details

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

File metadata

  • Download URL: fastapi-analytics-1.0.13.tar.gz
  • Upload date:
  • Size: 3.7 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.13.tar.gz
Algorithm Hash digest
SHA256 8d3862f306b933ee2998e52a017a944bb0f493dc4a50cba9f4034a1fc472c058
MD5 74d3cceb907c2445124a9540c3b77e6a
BLAKE2b-256 ca0812a76019af3825bfe5ee2d3aa7104ec4bf5e8c8d2f69ac9f7defc49906f2

See more details on using hashes here.

Provenance

File details

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

File metadata

  • Download URL: fastapi_analytics-1.0.13-py3-none-any.whl
  • Upload date:
  • Size: 4.6 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.13-py3-none-any.whl
Algorithm Hash digest
SHA256 cedf730803f6be6c55540a1c1429e5b972392d9d6076109d8292359b4ee7976f
MD5 b35e4828e29832a1b72e03712fdf2a24
BLAKE2b-256 d211776ec4b27fb26f3632ad1ad05c62cb1ffaeb33c3ee58904576d7338c2fbf

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