README.md in api_analytics-1.1.1 vs README.md in api_analytics-1.1.2
- old
+ new
@@ -2,17 +2,17 @@
A lightweight API analytics solution, complete with a dashboard.
## Getting Started
-### 1. Generate a new API key
+### 1. Generate an 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.
+Head to https://apianalytics.dev/generate 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's also required in order to view your API 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.
+Add 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.
```bash
gem install api_analytics
```
@@ -53,37 +53,62 @@
end
```
### 3. View your analytics
-Your 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 stats on our dashboard, or accessed directly via our data API.
+Your API will now log and store incoming request data on all valid routes. Your logged data can be viewed using two methods:
-You 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 you want analytics for.
+1. Through visualizations and statistics on our dashboard
+2. Accessed directly via our data API
+You 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.
+
#### Dashboard
-Head to https://my-api-analytics.vercel.app/dashboard and paste in your API key to access your dashboard.
+Head to https://apianalytics.dev/dashboard and paste in your API key to access your dashboard.
-Demo: https://my-api-analytics.vercel.app/dashboard/demo
+Demo: https://apianalytics.dev/dashboard/demo
-
+
#### Data API
-Logged data for all requests can be accessed via our API. Simply send a GET request to `https://api-analytics-server.vercel.app/api/data` with your API key set as `API-Key` in headers.
+Logged data for all requests can be accessed via our REST API. Simply send a GET request to `https://apianalytics-server.com/api/data` with your API key set as `X-AUTH-TOKEN` in headers.
+##### Python
+
```py
import requests
headers = {
- "API-Key": <API-KEY>
+ "X-AUTH-TOKEN": <API-KEY>
}
-response = requests.get("https://api-analytics-server.vercel.app/api/data", headers=headers)
+response = requests.get("https://apianalytics-server.com/api/data", headers=headers)
print(response.json())
```
+##### Node.js
+
+```js
+fetch("https://apianalytics-server.com/api/data", {
+ headers: { "X-AUTH-TOKEN": <API-KEY> },
+})
+ .then((response) => {
+ return response.json();
+ })
+ .then((data) => {
+ console.log(data);
+ });
+```
+
+##### cURL
+
+```bash
+curl --header "X-AUTH-TOKEN: <API-KEY>" https://apianalytics-server.com/api/data
+```
+
## Monitoring (coming soon)
Opt-in active API monitoring is coming soon. Our servers will regularly ping your API endpoints to monitor uptime and response time. Optional email alerts to notify you when your endpoints are down can be subscribed to.
@@ -102,10 +127,27 @@
- Status code
- Response time
- API hostname
- API framework (FastAPI, Flask, Express etc.)
-Data collected is only ever used to populate your analytics dashboard. Your data is anonymous, with the API key the only link between you and you API's analytics. Should you lose your API key, you will have no method to access your API analytics. Inactive API keys (> 1 year) and its associated API request data may be deleted.
+Data collected is only ever used to populate your analytics dashboard. All data stored 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.
### Delete Data
-At any time, you can delete all stored data associated with your API key by going to https://my-api-analytics.vercel.app/delete and entering your API key.
+At any time, you can delete all stored data associated with your API key by going to https://apianalytics.dev/delete and entering your API key.
+
+API keys and their associated API request data are scheduled be deleted after 1 year of inactivity.
+
+## Development
+
+This project is still in the early stages of development and bugs are to be expected.
+
+## 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
+