Skip to content

Commit

Permalink
Merge pull request #106 from electerious/develop
Browse files Browse the repository at this point in the history
v1.7.0
  • Loading branch information
electerious authored Apr 19, 2020
2 parents 27509fc + 9cc66a8 commit 3f92c59
Show file tree
Hide file tree
Showing 148 changed files with 3,751 additions and 773 deletions.
2 changes: 1 addition & 1 deletion .github/FUNDING.yml
Original file line number Diff line number Diff line change
@@ -1 +1 @@
custom: ['http://paypal.me/electerious']
custom: ['https://paypal.me/electerious', 'https://www.buymeacoffee.com/electerious']
17 changes: 16 additions & 1 deletion CHANGELOG.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,6 +4,21 @@ All notable changes to this project will be documented in this file.

The format is based on [Keep a Changelog](http://keepachangelog.com/en/1.0.0/) and this project adheres to [Semantic Versioning](http://semver.org/spec/v2.0.0.html).

## [1.7.0] - 2020-04-19

### Added

- Filter bar to quickly change what you're viewing
- [Documention website](https://docs.ackee.electerious.com/#/)
- Browsers, devices and operating systems are now visible in the UI (thanks [@RomainCscn](https://github.com/RomainCscn))
- Browser and screen resolutions allow you to view width and height combined (thanks [@RomainCscn](https://github.com/RomainCscn))
- View the last 24 hours, 7 days, last 30 days or the top entries of all time (thanks [@RomainCscn](https://github.com/RomainCscn))

### Changed

- API returns more entries (25 -> 30)
- Loading design in header

## [1.6.1] - 2020-03-25

### Fixed
Expand Down Expand Up @@ -129,4 +144,4 @@ The format is based on [Keep a Changelog](http://keepachangelog.com/en/1.0.0/) a

### Added

- Everything
- Everything
15 changes: 13 additions & 2 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -83,8 +83,11 @@ Make sure to install and update all dependencies before you setup Ackee.
- [/domains/:domainId/pages](docs/pages.md)
- [/domains/:domainId/referrers](docs/referrers.md)
- [/domains/:domainId/durations](docs/durations.md)
- [/domains/:domainId/languages](docs/languages.md)
- [/domains/:domainId/systems](docs/systems.md)
- [/domains/:domainId/devices](docs/devices.md)
- [/domains/:domainId/browsers](docs/browsers.md)
- [/domains/:domainId/sizes](docs/sizes.md)
- [/domains/:domainId/languages](docs/languages.md)

### Options

Expand All @@ -94,10 +97,18 @@ Ackee uses environment variables and supports [`.env` files](https://www.npmjs.c

More documentation and guides are located in [the /docs folder](docs/). Also take a look at the [FAQ](docs/FAQ.md) if you have any questions left.

#### Donate

I am working hard on continuously developing and maintaining Ackee. Please consider making a donation to keep the project going strong and me motivated.

- [Donate via PayPal](https://paypal.me/electerious)
- [Buy me a coffee](https://www.buymeacoffee.com/electerious)

#### Related

- [ackee-tracker](https://github.com/electerious/ackee-tracker) - Transfer data to Ackee
- [gatsby-plugin-ackee-tracker](https://github.com/Burnsy/gatsby-plugin-ackee-tracker) - Gatsby plugin for Ackee
- [Soapberry](https://wordpress.org/plugins/soapberry/) - WordPress plugin for Ackee
- [Ackee-PHP](https://github.com/BrookeDot/ackee-php) - A PHP Class for Ackee
- [use-ackee](https://github.com/electerious/use-ackee) - Use Ackee in React
- [nuxt-ackee](https://github.com/bdrtsky/nuxt-ackee) - Nuxt.js module for Ackee
- [nuxt-ackee](https://github.com/bdrtsky/nuxt-ackee) - Nuxt.js module for Ackee
29 changes: 4 additions & 25 deletions docs/FAQ.md
Original file line number Diff line number Diff line change
Expand Up @@ -37,6 +37,7 @@ Ackee is the right tool for you if Matomo offers more than you need and when you

Ackee and Fathom are very similar. Both in the way they display data and how they process it. The biggest advantages at the moment of writing:

- Ackee is free and open-source
- Ackee offers a documented REST API that lets you build upon it. The API can be used for custom import scripts or apps that display your current visitor stats in the menu bar. The possibilities are endless.
- Ackee allows you to track more than just page/site views (browser, system, etc.). This is optional and off by default, but great for people/companies that need more insights.

Expand All @@ -63,7 +64,7 @@ Examples:

### Pages > Top pages

The 25 pages of a domain with the most views. Each visit or reload of a page will increase this value. The views aren't unique, because Ackee can't track returning users for individual pages.
The 30 pages of a domain with the most views. Each visit or reload of a page will increase this value. The views aren't unique, because Ackee can't track returning users for individual pages.

Examples:

Expand All @@ -72,34 +73,12 @@ Examples:

### Pages > Recent pages

The last 25 page visits of the last 7 days. Sorted by time.

### Referrers > Top referrers

The top 25 pages from which your visitors have come in the last 7 days. Sorted by popularity.

### Referrers > New referrers

Pages from which your visitors have come in the last 7 days. Ignores old referrers. Sorted by time.

### Referrers > Recent referrers

The last 25 pages from which your visitors have come in the last 7 days. Sorted by time.
The last 30 page visits of the last 7 days. Sorted by time.

### Durations > Average durations

The average time users spend on your sites. Tracked in an interval of 15s. Visits above 30m won't be added to the average, because some visitors keep sites open in the background. This distorts the average and will be omitted.

### Durations > Detailed durations

The time users spend on your sites, grouped by similar durations in an interval of 15s. This view shows the first 30m and gives you more insides.

### Languages > Top languages

The top 25 user languages of the last 7 days. Sorted by popularity.

The user language is the language of the user's browser.

### Languages > Recent languages

The last 25 user languages from the last 7 days. Sorted by time.
The time users spend on your sites, grouped by similar durations in an interval of 15s. This view shows the first 30m and gives you more insides.
168 changes: 168 additions & 0 deletions docs/browsers.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,168 @@
# Browsers

- [Top browsers without version](#top-browsers-without-version)
- [Top browsers with version](#top-browsers-with-version)
- [Recent browsers without version](#recent-browsers-without-version)
- [Recent browsers with version](#recent-browsers-with-version)

## Top browsers without version

Get the top 30 browsers without the version.

### Request

```
GET /domains/:domainId/browsers?sorting=top&type=noVersion
GET /domains/:domainId/browsers?sorting=top&type=noVersion&range=daily
GET /domains/:domainId/browsers?sorting=top&type=noVersion&range=weekly
GET /domains/:domainId/browsers?sorting=top&type=noVersion&range=monthly
GET /domains/:domainId/browsers?sorting=top&type=noVersion&range=allTime
```

### Headers

| Name | Example |
|:-----------|:------------|
| Authorization | `Authorization: Bearer :tokenId` |

### Response

```
Status: 200 OK
```

```json
{
"type": "browsers",
"data": [
{
"type": "browser",
"data": {
"id": "Safari",
"count": 1
}
}
]
}
```

## Top browsers with version

Get the top 30 browsers with the version.

### Request

```
GET /domains/:domainId/browsers?sorting=top&type=withVersion
GET /domains/:domainId/browsers?sorting=top&type=withVersion&range=daily
GET /domains/:domainId/browsers?sorting=top&type=withVersion&range=weekly
GET /domains/:domainId/browsers?sorting=top&type=withVersion&range=monthly
GET /domains/:domainId/browsers?sorting=top&type=withVersion&range=allTime
```

### Headers

| Name | Example |
|:-----------|:------------|
| Authorization | `Authorization: Bearer :tokenId` |

### Response

```
Status: 200 OK
```

```json
{
"type": "browsers",
"data": [
{
"type": "browser",
"data": {
"id": {
"browserName": "Safari",
"browserVersion": "5.1"
},
"count": 1
}
}
]
}
```

## Recent browsers without version

Get the 30 most recent browsers without the version.

### Request

```
GET /domains/:domainId/browsers?sorting=recent&type=noVersion
```

### Headers

| Name | Example |
|:-----------|:------------|
| Authorization | `Authorization: Bearer :tokenId` |

### Response

```
Status: 200 OK
```

```json
{
"type": "browsers",
"data": [
{
"type": "browser",
"data": {
"id": "Safari",
"created": "2019-09-19T15:54:00.020Z"
}
}
]
}
```

## Recent browsers with version

Get the 30 most recent browsers with the version.

### Request

```
GET /domains/:domainId/browsers?sorting=recent&type=withVersion
```

### Headers

| Name | Example |
|:-----------|:------------|
| Authorization | `Authorization: Bearer :tokenId` |

### Response

```
Status: 200 OK
```

```json
{
"type": "browsers",
"data": [
{
"type": "browser",
"data": {
"id": {
"browserName": "Safari",
"browserVersion": "5.1"
},
"created": "2019-09-19T15:54:00.020Z"
}
}
]
}
```
Loading

0 comments on commit 3f92c59

Please sign in to comment.