Skip to main content

Monitoring and analytics for Python API frameworks.

Project description

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

pip install api-analytics

Django

Set you API key as an environment variable.

In settings.py:

from os import getenv

ANALYTICS_API_KEY = getenv("API_KEY")

MIDDLEWARE = [
    'api_analytics.django.Analytics',  # Add middleware
    ...
]

FastAPI

from fastapi import FastAPI
from api_analytics.fastapi import Analytics

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

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

Flask

from flask import Flask
from api_analytics.flask import add_middleware

app = Flask(__name__)
add_middleware(app, <api_key>)  # Add middleware

@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.9.tar.gz (41.2 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.9-py3-none-any.whl (29.5 kB view details)

Uploaded Python 3

File details

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

File metadata

  • Download URL: api-analytics-1.0.9.tar.gz
  • Upload date:
  • Size: 41.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 api-analytics-1.0.9.tar.gz
Algorithm Hash digest
SHA256 8131df6196a23f2563d20eaddc1a195e539f4f0c517af5f73cc31d1a631fcdd4
MD5 64dacf79b2ddd6e4933849b6a24ecc64
BLAKE2b-256 defba08ebe9964c92c4f3f71d0cdb3776174065bae44687f73f705067e1a2c17

See more details on using hashes here.

File details

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

File metadata

  • Download URL: api_analytics-1.0.9-py3-none-any.whl
  • Upload date:
  • Size: 29.5 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.9-py3-none-any.whl
Algorithm Hash digest
SHA256 d46c200b0f0ca60773aeeeb0048a2d12c31977ebf40f98090f9515f665010f5d
MD5 3f9ce98eedb5a9efcffe19c7ef7c8a23
BLAKE2b-256 76b60b1dfa3a798a238c9538fff28c614016bbd1017b123750d784709d090885

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