Package: api-analytics
API AnalyticsA free lightweight API analytics solution, complete with a dashboard.Getting Started1. Generate an API keyHead tohttps://apianalytics.dev/generateto generate your unique API key with a single click. This key is used to monitor your API server and should be stored privately. It's also required in order to view your API analytics dashboard and data.2. Add middleware to your APIAdd our lightweight middleware to your API. Almost all processing is handled by our servers so there is minimal impact on the performance of your API.FastAPIpipinstallfastapi-analyticsimportuvicornfromfastapiimportFastAPIfromapi_analytics.fastapiimportAnalyticsapp=FastAPI()app.add_middleware(Analytics,api_key=<API-KEY>)# Add middleware@app.get('/')asyncdefroot():return{'message':'Hello World!'}if__name__=="__main__":uvicorn.run("app:app",reload=True)ConfigurationCustom mapping functions can be provided to override the default behaviour and tailor the retrival of information about each incoming request to your API's environment and usage.fromfastapiimportFastAPIfromapi_analytics.fastapiimportAnalytics,Configconfig=Config()config.get_ip_address=lambdarequest:request.headers.get('X-Forwarded-For',request.client.host)config.get_user_agent=lambdarequest:request.headers.get('User-Agent','')app=FastAPI()app.add_middleware(Analytics,api_key=<API-KEY>,config=config)# Add middlewareFlaskpipinstallapi-analyticsfromflaskimportFlaskfromapi_analytics.flaskimportadd_middlewareapp=Flask(__name__)add_middleware(app,<API-KEY>)# Add middleware@app.get('/')defroot():return{'message':'Hello World!'}if__name__=="__main__":app.run()ConfigurationfromflaskimportFlaskfromapi_analytics.flaskimportadd_middleware,Configapp=Flask(__name__)config=Config()config.get_ip_address=lambdarequest:request.headers['X-Forwarded-For']config.get_user_agent=lambdarequest:request.headers['User-Agent']add_middleware(app,<API-KEY>,config)# Add middlewareDjangopipinstallapi-analyticsAssign your API key toANALYTICS_API_KEYinsettings.pyand add the Analytics middleware to the top of your middleware stack.ANALYTICS_API_KEY=<API-KEY>MIDDLEWARE=['api_analytics.django.Analytics',# Add middleware...]ConfigurationAssign your config toANALYTICS_CONFIGinsettings.py.fromapi_analytics.djangoimportConfigconfig=Config()config.get_ip_address=lambdarequest:request.headers['X-Forwarded-For']config.get_user_agent=lambdarequest:request.headers['User-Agent']ANALYTICS_CONFIG=configTornadopipinstalltornado-analyticsModify your handler to inherit fromAnalytics. Create a__init__()method, passing along the application and response along with your unique API key.importasynciofromtornado.webimportApplicationfromapi_analytics.tornadoimportAnalytics# Inherit from the Analytics middleware classclassMainHandler(Analytics):def__init__(self,app,res):super().__init__(app,res,<API-KEY>)# Provide api keydefget(self):self.write({'message':'Hello World!'})defmake_app():returnApplication([(r"/",MainHandler),])if__name__=="__main__":app=make_app()app.listen(8080)IOLoop.instance().start()Configurationfromapi_analytics.tornadoimportAnalytics,ConfigclassMainHandler(Analytics):def__init__(self,app,res):config=Config()config.get_ip_address=lambdarequest:request.headers['X-Forwarded-For']config.get_user_agent=lambdarequest:request.headers['User-Agent']super().__init__(app,res,<API-KEY>,config)# Provide api key3. View your analyticsYour API will now log and store incoming request data on all valid routes. Your logged data can be viewed using two methods:Through visualizations and statistics on our dashboardAccessed directly via our data APIYou can use the same API key across multiple APIs, but all your data will appear in the same dashboard. We recommend generating a new API key for each additional API server you want analytics for.DashboardHead tohttps://apianalytics.dev/dashboardand paste in your API key to access your dashboard.Demo:https://apianalytics.dev/dashboard/demoData APILogged data for all requests can be accessed via our REST API. Simply send a GET request tohttps://apianalytics-server.com/api/datawith your API key set asX-AUTH-TOKENin headers.Pythonimportrequestsheaders={"X-AUTH-TOKEN":<API-KEY>}response=requests.get("https://apianalytics-server.com/api/data",headers=headers)print(response.json())Node.jsfetch("https://apianalytics-server.com/api/data",{headers:{"X-AUTH-TOKEN":<API-KEY>},}).then((response)=>{returnresponse.json();}).then((data)=>{console.log(data);});cURLcurl--header"X-AUTH-TOKEN: <API-KEY>"https://apianalytics-server.com/api/dataParametersYou can filter your data by providing URL parameters in your request.date- specifies a particular day the requests occurred on (YYYY-MM-DD)dateFrom- specifies the lower bound of a date range the requests occurred in (YYYY-MM-DD)dateTo- specifies the upper bound of a date range the requests occurred in (YYYY-MM-DD)ipAddress- an IP address string of the clientstatus- an integer status code of the responselocation- a two-character location code of the clientExample:curl--header"X-AUTH-TOKEN: <API-KEY>"https://apianalytics-server.com/api/data?dateFrom=2022-01-01&dateTo=2022-06-01&status=200MonitoringActive API monitoring can be set up by heading tohttps://apianalytics.dev/monitoringto enter you API key. Our servers will regularly ping chosen API endpoints to monitor uptime and response time.Data and SecurityAll data is stored securely in compliance with The EU General Data Protection Regulation (GDPR).For any given request to your API, data recorded is limited to:Path requested by clientClient IP addressClient operating systemClient browserRequest method (GET, POST, PUT, etc.)Time of requestStatus codeResponse timeAPI hostnameAPI framework (FastAPI, Flask, Express etc.)Data collected is only ever used to populate your analytics dashboard. All stored data is 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.Data DeletionAt any time you can delete all stored data associated with your API key by going tohttps://apianalytics.dev/deleteand entering your API key.API keys and their associated logged request data are scheduled to be deleted after 6 months of inactivity.ContributionsContributions, 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