Skip to content

Commit

Permalink
update endpoint
Browse files Browse the repository at this point in the history
  • Loading branch information
gernest committed Feb 8, 2024
1 parent edee490 commit c7f6b15
Show file tree
Hide file tree
Showing 3 changed files with 9 additions and 9 deletions.
2 changes: 1 addition & 1 deletion docs/2-config.md
Original file line number Diff line number Diff line change
Expand Up @@ -201,7 +201,7 @@ with issued certificates.

### acmeDomain
> `acmeDomain` should be the domain name that is used to point to your server.
> For example we host vince instance on `api.vinceanalytics.com` so we use this as `acmeDomain`
> For example we host vince instance on `cloud.vinceanalytics.com` so we use this as `acmeDomain`
*env*
: `VINCE_ACME_DOMAIN` example `VINCE_ACME_DOMAIN=example.org`
Expand Down
10 changes: 5 additions & 5 deletions docs/3-api.md → docs/3-stats.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@


# API
# Stats API

> **CC-BY-S-4.0** *This section was initially copied from Plausible Analytics docs*
Expand Down Expand Up @@ -91,7 +91,7 @@ This endpoint returns the number of current visitors on your site. A current vis
in the last 5 minutes.

```bash title="Try it yourself"
curl 'https://plausible.io/api/v1/stats/realtime/visitors?site_id=$SITE_ID'
curl 'https://cloud.vinceanalytics.com/api/v1/stats/realtime/visitors?site_id=$SITE_ID'
-H "Authorization: Bearer ${TOKEN}"
```

Expand All @@ -113,7 +113,7 @@ This endpoint aggregates metrics over a certain time period. If you are familiar


```bash
curl 'https://plausible.io/api/v1/stats/aggregate?site_id=$SITE_ID&period=6mo&metrics=visitors,pageviews,bounce_rate,visit_duration' \
curl 'https://cloud.vinceanalytics.com/api/v1/stats/aggregate?site_id=$SITE_ID&period=6mo&metrics=visitors,pageviews,bounce_rate,visit_duration' \
-H "Authorization: Bearer ${TOKEN}"
```

Expand Down Expand Up @@ -169,7 +169,7 @@ the main visitor graph.


```bash title="Try it yourself"
curl 'https://plausible.io/api/v1/stats/timeseries?site_id=$SITE_ID&period=6mo'
curl 'https://cloud.vinceanalytics.com/api/v1/stats/timeseries?site_id=$SITE_ID&period=6mo'
-H "Authorization: Bearer ${TOKEN}"
```

Expand Down Expand Up @@ -219,7 +219,7 @@ This endpoint can be used to fetch data for `Top sources`, `Top pages`, `Top cou


```bash title="Try it yourself"
curl 'https://plausible.io/api/v1/stats/breakdown?site_id=$SITE_ID&period=6mo&property=visit:source&metrics=visitors,bounce_rate&limit=5' \
curl 'https://cloud.vinceanalytics.com/api/v1/stats/breakdown?site_id=$SITE_ID&period=6mo&property=visit:source&metrics=visitors,bounce_rate&limit=5' \
-H "Authorization: Bearer ${TOKEN}"
```

Expand Down
6 changes: 3 additions & 3 deletions docs/4-metrics.md
Original file line number Diff line number Diff line change
Expand Up @@ -35,7 +35,7 @@ The number of people currently on your site. This metric does not depend on the

## Direct / None

Includes visitors who typed your URL into their browser or clicked a link in an email. It also includes other visitors who were [missing a referrer header](https://plausible.io/blog/referrer-policy).
Includes visitors who typed your URL into their browser or clicked a link in an email. It also includes other visitors who were [missing a referrer header](https://cloud.vinceanalytics.com/blog/referrer-policy).

## Entry Pages

Expand Down Expand Up @@ -117,7 +117,7 @@ When a visitor converts for a particular goal they’ll be counted as a unique c

## Unique Visitors

The number of people who visited your site. We are privacy-friendly so we don't use cookies and other persistent identifiers. If a person visits from multiple devices or on multiple days, they are counted as separate visitors. You can learn more about [how we count unique visitors](https://plausible.io/data-policy).
The number of people who visited your site. We are privacy-friendly so we don't use cookies and other persistent identifiers. If a person visits from multiple devices or on multiple days, they are counted as separate visitors. You can learn more about [how we count unique visitors](https://cloud.vinceanalytics.com/data-policy).

## Views Per Visit (or Pages / Session)

Expand All @@ -133,4 +133,4 @@ If you have issues with high bounce rates on your site, you can try to set up so

A session (also known as a visit) is a set of actions that a user takes on your site. A visit is started when a visitor first lands on your page and ends when no action is taken on your site for 30 minutes.

You can read more about how you can use these metrics to [measure your website's or startup's progress and make better decisions](https://plausible.io/blog/analytics-metrics-definitions).
You can read more about how you can use these metrics to [measure your website's or startup's progress and make better decisions](https://cloud.vinceanalytics.com/blog/analytics-metrics-definitions).

0 comments on commit c7f6b15

Please sign in to comment.