Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
17 changes: 17 additions & 0 deletions docs/stats-api.md
Original file line number Diff line number Diff line change
Expand Up @@ -455,3 +455,20 @@ In this example, we're counting goal completions for a goal named "Signup" for u
<ApiV2Example id="example-behavioral-filters" />

</SiteContextProvider>

## Quirks

The stats API is created to be able to both pragmatically and performantly query the underlying dataset Plausible stores. To make
it possible, the API has certain limitations and quirks. These include:

### Imported data can not always be included

As imported data from Google Analytics or other sources is stored as aggregates, responses for queries with certain metrics,
filters and dimensions may not contain imported data. [See example](#example-imports-warning)

### Metric values may change depending on metrics requested

When requesting metrics such as `visits` or `visitors`, the system may use different database tables depending on your query and use
different heuristics to calculate values. As such, the value may slightly change depending on the result.

Our testing has shown this to be a small effect (less than 1 percent).
2 changes: 1 addition & 1 deletion src/js/apiv2-examples/revenue-warning-response.json
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
{
"results": [
{"metrics": [null], "dimensions": ["Visit /"]}
{"metrics": [null], "dimensions": ["PurchaseUSD"]}
],
"meta": {
"metric_warnings": {
Expand Down