Skip to content

Commit

Permalink
docs: Add analytics flag details
Browse files Browse the repository at this point in the history
  • Loading branch information
palash25 committed Oct 26, 2018
1 parent 04babde commit 9646146
Showing 1 changed file with 60 additions and 1 deletion.
61 changes: 60 additions & 1 deletion docs/appbase/app.md
Original file line number Diff line number Diff line change
Expand Up @@ -19,7 +19,7 @@ The above commands will only give basic details of the app such as its name, ID,
If you want more details such as credentials and metrics, you can pass in defined switches. The full version of `app` command looks like-

```sh
abc app [-c|--creds] [-m|--metrics] [ID|Appname]
abc app [-c|--creds] [-m|--metrics] [-a| --analytics] [ID|Appname]
```

#### Example
Expand Down Expand Up @@ -48,3 +48,62 @@ Records: 42
```

⭐️ It shows API calls and number of records created on a per day basis (just like the graph you see on dashboard.appbase.io).


### Accessing app analytics (only for paid users)

Paid users can access analytics data for a particular app. Currently the following analytics endpoints are supported:
- overview
- noresultsearches
- popularresults
- popularsearches
- popularfilters
- geoip
- latency

#### Example

By default the command will ping the overview endpoint

```sh
> abc app -a MyCoolApp

Analytics(Overview) Results:
No Result Searches
+-------+------+
| COUNT | KEY |
+-------+------+
| 1 | blah |
| 1 | gurr |
+-------+------+
No Result Searches
+-------+--------------+
| COUNT | KEY |
+-------+--------------+
| 1 | gru |
| ... | ... |
| 1 | wonder woman |
| 1 | wonderland |
+-------+--------------+
Search Volume Results
+-------+---------------+---------------------+
| COUNT | KEY | DATE-AS-STR |
+-------+---------------+---------------------+
| 7 | 1540512000000 | 2018/10/26 00:00:00 |
+-------+---------------+---------------------+
```

To ping other analytics endpoints the `endpoint` flag can be used. For example

```sh
> abc app -a --endpoint=latency MyCoolApp

Analytics(Latency) Results:
+-------+-----+
| COUNT | KEY |
+-------+-----+
| 2 | 0 |
| .. | .. |
| 0 | 10 |
+-------+-----+
```

0 comments on commit 9646146

Please sign in to comment.