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.

Django

python -m pip install api-analytics

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',
    ...
]

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.7.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.7-py3-none-any.whl (29.5 kB view details)

Uploaded Python 3

File details

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

File metadata

  • Download URL: api-analytics-1.0.7.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.7.tar.gz
Algorithm Hash digest
SHA256 c5d4de754810f4a323d77fbde65147857e7e7336511874db1d692a27ecc7dd48
MD5 44ab1890bab9b362a7c428fb71bff262
BLAKE2b-256 78f9c46e77c818fad829f49203bcae457eb5c8c1b97324a43ef06504c6e657e4

See more details on using hashes here.

File details

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

File metadata

  • Download URL: api_analytics-1.0.7-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.7-py3-none-any.whl
Algorithm Hash digest
SHA256 d945957058eec7361cd30413077b2b69f0ca890b777bf67f94ea0e3ec3be547b
MD5 3f3319234d5e03cb4a9b1f04c3fee221
BLAKE2b-256 28e939b4ec0310a5d2efb083a348a1cf11888115bf86a815bdbcfab4be7f828a

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