Frequently Asked Questions

The project can be easily self-hosted following the guide here. 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.

This project is funded by myself as a hobby project. Donations are always welcome and greatly appreciated, and will go towards server costs and further development.

Donate

Your API key is the only link between you and your logged requests. We do not store any other forms of authentication such as email addresses. If you have lost your API key, please get in contact with us, and we may be able to recover it for you. If do not access your dashboard or data again, all data associated with the account will be deleted after 3 months.

The service is currently entirely free. In future, we may transition to a fremium-based service with the introduction of a paid tier for higher usage, but a free tier will always remain available.

Account creation is complete free and takes a second to do. Accounts are controlled entirely through a unique randomly-generated API key. Get your API key here.

We adhere to GDPR regulations and requirements. All data is stored securely on London-based servers. Data is retained only for the duration necessary to deliver this service and is used solely for that purpose. You may delete your stored data at any time. It is never shared with or sold to any other third parties. Our privacy policy can be found here.

In order to keep the service free, we can currently only store up to 1.5 million requests per user. When you hit this limit, old logged requests will be replaced by new requests. If you find this is not enough, we recommend trying another service following the self-hosting guide. We may introduce a paid tier in the future that could support much higher usage limits if there is demand.

In order to keep the service free, we can currently only store up to 1.5 million requests per user. If you have hit this limit, old requests will be replaced with new requests.

Occassionally we will have an outage that is reflected in your dashboard. You can track outages here.

The project is open source and contributions, feedback and suggestions are always welcome.

Data is only stored for as long as the service may be in use. Data associated with an account is scheduled for deletion after 3 months of inactivity (i.e. no access to the dashboard, monitor, or data API).

You can delete your account and all associated data at any time by entering your API key here.

The service currently doesn't allow for the ability for users to directly amend or modify their logged request data themselves. If you have a specific request, please get in contact with us.

You can access your raw logged request data by sending a GET request to our data API.

curl --header "X-AUTH-TOKEN: <API-KEY>" https://apianalytics-server.com/api/data

A range of URL parameters can be used to filter the data:

• page: The page number, with a maximum page size of 50,000 (defaults to 1).
• date: The exact day the requests occurred on (yyyy-mm-dd).
• dateFrom: The lower bound of a date range for when the requests occurred (yyyy-mm-dd).
• dateTo: The upper bound of a date range for when the requests occurred (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.
• user_id: A custom user identifier (only relevant if a get_user_id mapper function has been set within the config).

Example:

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

APIs can be deployed in a wide-range of environments, and the ideal values to be extracted from a request can differ. The API Analytics middleware is flexible in how you control this, allowing custom mapping functions to determine how a given field is extracted from a request.

For example, if your API is behind a reverse proxy, the client's IP address may be re-written to the header X-Real-IP.

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

config = Config(
    get_ip_address=lambda request: request.headers.get('X-REAL-IP', '')
)

app = FastAPI()
app.add_middleware(Analytics, api_key=<API-KEY>, config=config)