api-analytics

KO | EN

gitlite — search

#python #deep-learning #react #docker #go #golang #java #reactjs #vue #docker-compose #nodejs #csharp

★ 655 Open GitHub ↗

Effortless monitoring and analytics for API frameworks.

// repository documentation

Was this content helpful?

★ 0 (0 ratings)

# API Analytics <img src="https://user-images.githubusercontent.com/41476809/210829625-697bba5b-97a8-45fa-91ce-d3c33fcfd0b2.png" align="right" height="140"/>

An effortless API analytics solution, complete with a dashboard.

Currently compatible with:

- Python: FastAPI, Flask, Django and Tornado
- JavaScript: Express, NestJS, Hono, Fastify, Koa and Elysia
- Go: Gin, Echo, Fiber and Chi
- Rust: Actix, Axum and Rocket
- Ruby: Rails and Sinatra
- PHP: Laravel and Native PHP
- C#: ASP.NET Core

![banner](https://github.com/user-attachments/assets/4d366f69-bb9b-43b7-8b9e-97a341d1b057)

## Getting Started

### 1. Generate an API key

Head to [apianalytics.dev/sign-up](https://apianalytics.dev/sign-up) to generate your unique API key with a single click. This key is used to monitor your specific API and should be stored privately. It will be required when accessing your API Analytics dashboard and logged data.

### 2. Add middleware to your API

Add the lightweight middleware to your API. Since most data processing is handled by the API Analytics server, it has minimal impact on your API's performance.

#### FastAPI

[![PyPi version](https://badgen.net/pypi/v/api-analytics)](https://pypi.org/project/api-analytics)

```bash
pip install api-analytics[fastapi]
```

```py
import uvicorn
from fastapi import FastAPI
from api_analytics.fastapi import Analytics

app = FastAPI()
app.add_middleware(Analytics, api_key="YOUR-API-KEY")  # Add middleware

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

if __name__ == "__main__":
    uvicorn.run("app:app", reload=True)
```

#### Flask

[![PyPi version](https://badgen.net/pypi/v/api-analytics)](https://pypi.org/project/api-analytics)

```bash
pip install api-analytics[flask]
```

```py
from flask import Flask
from api_analytics.flask import add_middleware

app = Flask(__name__)
add_middleware(app, "YOUR-API-KEY")  # Add middleware

@app.get('/')
def root():
    return {'message': 'Hello, World!'}

if __name__ == "__main__":
    app.run()
```

#### Django

[![PyPi version](https://badgen.net/pypi/v/api-analytics)](https://pypi.org/project/api-analytics)

```bash
pip install api-analytics[django]
```

Assign your API key to `ANALYTICS_API_KEY` in `settings.py` and add the `Analytics` middleware to the top of your middleware stack.

```py
ANALYTICS_API_KEY = "YOUR-API-KEY"

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

#### Express

[![Npm package version](https://img.shields.io/npm/v/@api-analytics/express)](https://www.npmjs.com/package/@api-analytics/express)

```bash
npm install @api-analytics/express
```

```js
import express from 'express';
import { expressAnalytics } from '@api-analytics/express';

const app = express();

app.use(expressAnalytics("YOUR-API-KEY")); // Add middleware

app.get('/', (req, res) => {
    res.send({ message: 'Hello, World!' });
});

app.listen(8080, () => {
    console.log('Server listening at http://localhost:8080');
})
```

#### Hono

[![Npm package version](https://img.shields.io/npm/v/@api-analytics/hono)](https://www.npmjs.com/package/@api-analytics/hono)

```bash
npm install @api-analytics/hono
```

```js
import { Hono } from 'hono';
import { serve } from '@hono/node-server';
import { honoAnalytics } from '@api-analytics/hono';

const app = new Hono();

app.use('*', honoAnalytics("YOUR-API-KEY"));

app.get('/', (c) => c.text('Hello, world!'));

serve(app, (info) => {
    console.log(`Server listening at http://localhost:${info.port}`);
});
```

#### Gin

[![Gin](https://img.shields.io/badge/go.mod-Gin-blue)](https://github.com/tom-draper/api-analytics/tree/main/analytics/go/gin)

```bash
go get -u github.com/tom-draper/api-analytics/analytics/go/gin
```

```go
package main

import (
    "net/http"
    "github.com/gin-gonic/gin"
    analytics "github.com/tom-draper/api-analytics/analytics/go/gin"
)

func root(c * gin.Context) {
    data := map[string]string{
        "message": "Hello, World!",
    }
    c.JSON(http.StatusOK, data)
}

func main() {
    r := gin.Default()
    
    r.Use(analytics.Analytics("YOUR-API-KEY")) // Add middleware

r.GET("/", root)
    r.Run(":8080")
}
```

#### Fiber

[![Fiber](https://img.shields.io/badge/go.mod-Fiber-blue)](https://github.com/tom-draper/api-analytics/tree/main/analytics/go/fiber)

```bash
go get -u github.com/tom-draper/api-analytics/analytics/go/fiber
```

```go
package main

import (
    "github.com/gofiber/fiber/v2"
    analytics "github.com/tom-draper/api-analytics/analytics/go/fiber"
)

func root(c *fiber.Ctx) error {
    data := map[string]string{
        "message": "Hello, World!",
    }
    return c.JSON(data)
}

func main() {
    app := fiber.New()

app.Use(analytics.Analytics("YOUR-API-KEY")) // Add middleware

app.Get("/", root)
    app.Listen(":8080")
}
```

#### Actix

[![Crates.io](https://img.shields.io/crates/v/actix-analytics.svg)](https://crates.io/crates/actix-analytics)

```bash
cargo add actix-analytics
```

```rust
use actix_web::{get, web, App, HttpServer, Responder, Result};
use serde::Serialize;
use actix_analytics::Analytics;

#[derive(Serialize)]
struct JsonData {
    message: String,
}

#[get("/")]
async fn index() -> Result<impl Responder> {
 let data = JsonData {
 message: "Hello, World!".to_string(),
 };
 Ok(web::Json(data))
}

#[actix_web::main]
async fn main() -> std::io::Result<()> {
 HttpServer::new(|| {
 App::new()
 .wrap(Analytics::new("YOUR-API-KEY")) // Add middleware
 .service(index)
 })
 .bind(("127.0.0.1", 8080))?
 .run()
 .await
}
```

#### Axum

[![Crates.io](https://img.shields.io/crates/v/axum-analytics.svg)](https://crates.io/crates/axum-analytics)

```bash
cargo add axum-analytics
```

```rust
use axum::{routing::get, Json, Router};
use axum_analytics::Analytics;
use serde::Serialize;
use std::net::SocketAddr;

#[derive(Serialize)]
struct JsonData {
    message: String,
}

async fn root() -> Json<JsonData> {
 let json_data = JsonData {
 message: String::from("Hello World!"),
 };
 Json(json_data)
}

#[tokio::main]
async fn main() {
    let app = Router::new()
        .route("/", get(root))
        .layer(Analytics::new("YOUR-API-KEY"));

let addr = SocketAddr::from(([127, 0, 0, 1], 8080));
    let listener = tokio::net::TcpListener::bind(addr).await.unwrap();
    println!("Server listening at: http://127.0.0.1:8080");
    axum::serve(listener, app).await.unwrap();
}
```

#### Rails

[![Gem version](https://img.shields.io/gem/v/api_analytics)](https://rubygems.org/gems/api_analytics)

```bash
gem install api_analytics
```

Add the analytics middleware to your rails application in `config/application.rb`.

```ruby
require 'rails'
require 'api_analytics'

Bundler.require(*Rails.groups)

module RailsMiddleware
 class Application < Rails::Application
 config.load_defaults 6.1
 config.api_only = true

config.middleware.use ::Analytics::Rails, "YOUR-API-KEY"  # Add middleware
  end
end
```

#### Sinatra

[![Gem version](https://img.shields.io/gem/v/api_analytics)](https://rubygems.org/gems/api_analytics)

```bash
gem install api_analytics
```

```ruby
require 'sinatra'
require 'api_analytics'

use Analytics::Sinatra, "YOUR-API-KEY"  # Add middleware

before do
    content_type 'application/json'
end

get '/' do
    {message: 'Hello, World!'}.to_json
end
```

#### Laravel

[![Packagist Version](https://img.shields.io/packagist/v/api-analytics/laravel?color=blue)](https://packagist.org/packages/api-analytics/laravel)

```bash
composer require api-analytics/laravel
```

Add your API key to `.env`:

```env
API_ANALYTICS_KEY=YOUR-API-KEY
```

```php
protected $middleware = [
    // ... other middleware
    \ApiAnalytics\Laravel\AnalyticsMiddleware::class, // Add middleware
];
```

#### ASP.NET Core

[![NuGet Version](https://img.shields.io/nuget/v/APIAnalytics.AspNetCore)](https://www.nuget.org/packages/APIAnalytics.AspNetCore)

```sh
dotnet add package APIAnalytics.AspNetCore
```

```cs
using Analytics;

var builder = WebApplication.CreateBuilder(args);
var app = builder.Build();

app.UseAnalytics("YOUR-API-KEY"); // Add middleware

app.MapGet("/", () => new { message = "Hello, World!" });

app.Run();
```

#### Other Frameworks

- **Python**: [Tornado](./analytics/python/tornado/README.md)
- **JavaScript**: [Fastify](./analytics/javascript/fastify/README.md), [Koa](./analytics/javascript/koa/README.md), [Elysia](./analytics/javascript/elysia/README.md), [Bun](./analytics/javascript/bun/README.md), [NestJS](./analytics/javascript/nestjs/README.md), [Oak](./analytics/javascript/oak/README.md), [H3](./analytics/javascript/h3/README.md)
- **Go**: [Echo](./analytics/go/echo/README.md), [Chi](./analytics/go/chi/README.md)
- **Rust**: [Rocket](./analytics/rust/rocket/analytics/README.md)
- **PHP**: [PHP](./analytics/php/php/README.md)

### 3. View your analytics

Your API will now log and store incoming request data on all routes. Logged data can be viewed using two methods:

1. Through visualizations and statistics on the dashboard
2. Accessed directly via the data API

The same API key can be used across multiple APIs, but all requests will appear in the same dashboard. It's recommended to generate a new API key for each of your API servers.

#### Dashboard

Head to [apianalytics.dev/dashboard](https://apianalytics.dev/dashboard) and paste in your API key to access your dashboard.

Demo: [apianalytics.dev/dashboard/demo](https://apianalytics.dev/dashboard/demo)

![Dashboard](https://github.com/user-attachments/assets/0cdc0045-74f3-41c7-9484-3568121f6cab)

#### Data API

Raw logged request data can be fetched from the data API. Simply send a GET request to `https://apianalytics-server.com/api/data` with your API key set as `X-AUTH-TOKEN` in the headers.

##### Python

```py
import requests

response = requests.get("https://apianalytics-server.com/api/data", headers={
    "X-AUTH-TOKEN": "YOUR-API-KEY"
})
print(response.json())
```

##### Node.js

```js
fetch("https://apianalytics-server.com/api/data", {
    headers: { "X-AUTH-TOKEN": "YOUR-API-KEY" },
})
    .then((response) => {
        return response.json();
    })
    .then((data) => {
        console.log(data);
    });
```

##### cURL

```bash
curl --header "X-AUTH-TOKEN: YOUR-API-KEY" https://apianalytics-server.com/api/data
```

##### Parameters

You can filter your data by providing URL parameters in your request.

- `page` - the page number, with a max page size of 50,000 (defaults to 1)
- `date` - the day the requests occurred on (`YYYY-MM-DD`)
- `dateFrom` - a lower bound of a date range the requests occurred in (`YYYY-MM-DD`)
- `dateTo` - a upper bound of a date range the requests occurred in (`YYYY-MM-DD`)
- `hostname` - the hostname of your service
- `ipAddress` - the IP address of the client
- `status` - the status code of the response
- `location` - a two-character location code of the client
- `userId` - a custom user identifier (only relevant if a `get_user_id` mapper function has been set within config)

Example:

```bash
curl --header "X-AUTH-TOKEN: YOUR-API-KEY" https://apianalytics-server.com/api/data?page=3&dateFrom=2022-01-01&hostname=apianalytics.dev&status=200&userId=b56cbd92-1168-4d7b-8d94-0418da207908
```

## Client ID and Privacy

By default, API Analytics logs and stores the client IP address of all incoming requests made to your API and infers a location (country) from each IP address if possible. The IP address is used as a form of client identification in the dashboard to estimate the number of users accessing your service.

This behaviour can be controlled through a privacy level defined in the configuration of the API middleware. There are three privacy levels from 0 (default) to a maximum of 2. A privacy level of 1 will disable storage of IP addresses, and a value of 2 will also disable location inference.

Privacy Levels:

- `0` - The client IP address is used to infer a location and then stored for user identification. (default)
- `1` - The client IP address is used to infer a location and then discarded.
- `2` - The client IP address is never accessed and location is never inferred.

```py
from fastapi import FastAPI
from api_analytics.fastapi import Analytics, Config

config = Config(privacy_level=2)  # Disable IP storing and location inference

app = FastAPI()
app.add_middleware(Analytics, api_key="YOUR-API-KEY", config=config)  # Add middleware
```

With any of these privacy levels, you have the option to define a custom user ID as a function of a request by providing a mapper function in the API middleware configuration. For example, your service may require an API key held in the `X-AUTH-TOKEN` header field which is used to identify a user of your service. In the dashboard, this custom user ID will identify the user in conjunction with the IP address or as an alternative depending on the privacy level set.

```py
from fastapi import FastAPI
from api_analytics.fastapi import Analytics, Config

config = Config(
    get_user_id=lambda request: request.headers.get('X-AUTH-TOKEN', '')
)

app = FastAPI()
app.add_middleware(Analytics, api_key="YOUR-API-KEY", config=config)  # Add middleware
```

## Data and Security

All data is stored securely, and in compliance with The EU General Data Protection Regulation (GDPR).

For any given request to your API, data recorded is strictly limited to:

- Request method (GET, POST, PUT, etc.)
- Endpoint requested
- User agent
- Client IP address (optional)
- Timestamp of the request
- Response status code
- Response time
- Hostname of API
- API framework in use (FastAPI, Flask, Express, etc.)

Data collected is only ever used to populate your analytics dashboard, and never shared with a third-party. All stored data is pseudo-anonymous, with the API key the only link between you and your logged request data. Should you lose your API key, you will have no method to access your API analytics.

View our full <a href="https://www.apianalytics.dev/privacy-policy">privacy policy</a> and <a href="https://www.apianalytics.dev/faq">frequently asked questions</a> on our website.

### Data Deletion

At any time, you can delete all stored data associated with your API key by going to [apianalytics.dev/delete](https://apianalytics.dev/delete) and entering your API key.

API keys and their associated logged request data are scheduled to be deleted after 6 months of dashboard inactivity, or if 3 months have elapsed without logging a request.

## Active Monitoring

Active endpoint monitoring can be set up by heading to [apianalytics.dev/monitoring](https://apianalytics.dev/monitoring) to enter your API key. Our servers will regularly ping chosen endpoints to monitor uptime and response time.

![Monitoring](https://github.com/user-attachments/assets/c2b70027-1172-49aa-95c3-8a123cc4e63d)

## Limitations

In order to keep the service free, up to 1 million requests can be stored against an API key. This is enforced as a rolling limit; old requests will be replaced by new requests. If your API would rapidly exceed this limit, we recommend you try other solutions or check out [self-hosting](./server/self-hosting/README.md).

## Self-Hosting

The project can be self-hosted by following the [guide](./server/self-hosting/README.md).

Please note: Self-hosting is still undergoing testing, development and further improvements to make it as easy as possible to deploy. It is currently recommended that you avoid self-hosting for production use.

## Contributions

Contributions, issues and feature requests are welcome.

- Fork it (https://github.com/tom-draper/api-analytics)
- Create your feature branch (`git checkout -b my-new-feature`)
- Commit your changes (`git commit -am 'Add some feature'`)
- Push to the branch (`git push origin my-new-feature`)
- Create a new Pull Request

---

If you find value in my work, consider supporting me.

Buy Me a Coffee: https://www.buymeacoffee.com/tomdraper 
PayPal: https://www.paypal.com/paypalme/tomdraper

api-analytics

Explore Similar Repositories

Was this content helpful?

Recent Feedback

Download README