Skip to main content

Monitoring and analytics for APIs.

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.2.tar.gz (40.4 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.2-py3-none-any.whl (28.6 kB view details)

Uploaded Python 3

File details

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

File metadata

  • Download URL: api-analytics-1.0.2.tar.gz
  • Upload date:
  • Size: 40.4 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.2.tar.gz
Algorithm Hash digest
SHA256 d287f2c2e7bbcaf7de60d66ac2a5b5239cfbffc1edaa18bd9369cbe0f0cf0184
MD5 c0e475625a0aa979b4c5e832897e2868
BLAKE2b-256 a4792a5755ac1ec659877a35732bcaf14af1ddbfaec04af0a8a11267b633761d

See more details on using hashes here.

File details

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

File metadata

  • Download URL: api_analytics-1.0.2-py3-none-any.whl
  • Upload date:
  • Size: 28.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 api_analytics-1.0.2-py3-none-any.whl
Algorithm Hash digest
SHA256 1916567f4d37bbca4820c23aea328a3ec4e55ed65dcc30d752f06681b5814050
MD5 58e8201694594747980604c4aec1269c
BLAKE2b-256 bf583d61ec74fc692513ef625b37d40916429ebe739c39e207764dc4e892da40

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