Skip to content

Commit 1250db1

Browse files
committed
Document some APIv2 quirks
1 parent 7ee26ef commit 1250db1

File tree

1 file changed

+17
-0
lines changed

1 file changed

+17
-0
lines changed

docs/stats-api.md

Lines changed: 17 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -455,3 +455,20 @@ In this example, we're counting goal completions for a goal named "Signup" for u
455455
<ApiV2Example id="example-behavioral-filters" />
456456

457457
</SiteContextProvider>
458+
459+
## Quirks
460+
461+
The stats API is created to be able to both pragmatically and performantly query the underlying dataset Plausible stores. To make
462+
it possible, the API has certain limitations and quirks. These include:
463+
464+
### Imported data can not always be included
465+
466+
As imported data from Google Analytics or other sources is stored as aggregates, responses for queries with certain metrics,
467+
filters and dimensions may not contain imported data. [See example](#example-imports-warning)
468+
469+
### Metric values may change depending on metrics requested
470+
471+
When requesting metrics such as `visits` or `visitors`, may query different database tables depending on your query and use
472+
different heuristics to calculate values. As such, the value may slightly change depending on the result.
473+
474+
Our testing has shown this to be a small effect (less than 1 percent).

0 commit comments

Comments
 (0)