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

Uploaded Python 3

File details

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

File metadata

  • Download URL: api-analytics-1.0.3.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.3.tar.gz
Algorithm Hash digest
SHA256 581d7bf93bfade3b70562143e73676a5314b0686c800736076f58b7f44fd96be
MD5 1cd4fb5cf7513819501f66d1f4f50cca
BLAKE2b-256 e2895c521ad5f4e13cacd1c85bcfdc281746114f8328f2363f6d049637702efe

See more details on using hashes here.

File details

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

File metadata

  • Download URL: api_analytics-1.0.3-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.3-py3-none-any.whl
Algorithm Hash digest
SHA256 865089e4fe495c3da86f91a0b193c0bec9cae77a6a14f36e54e4e995f1802728
MD5 5b407d2cebfefe45303529b7dafccbc2
BLAKE2b-256 7b61c1b6b02bfc265f066133d2c54deb956d81ca92a7fd570480d45d369ea4f4

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