[
https://issues.apache.org/jira/browse/UNOMI-1022?page=com.atlassian.jira.plugin.system.issuetabpanels:all-tabpanel
]
Serge Huber updated UNOMI-1022:
-------------------------------
Description:
h3. In short
The manual does not explain IP range reports or the special totals in report
results, so integrators have to guess what the numbers mean.
h3. Details
* "Queries and aggregations" lists IP range aggregates but has no section for
them.
* {{_all}}, {{_filtered}}, {{_missing}}, range bucket keys and bound semantics
({{from}} included, {{to}} excluded) are not explained, nor are the accepted
date intervals.
h3. Fix
Add an IP range section, a "Reading the results" section and the list of date
intervals.
was:
h3. In short
The documentation does not explain how to group visitors by IP address range,
or what the special totals in report results mean. People integrating with
Unomi have to guess, which leads to misread numbers and support questions.
h3. Summary
The "Queries and aggregations" page of the manual lists IP range among the
supported aggregations but has no IP range section. It also never explains how
to read aggregate results:
* The special keys: {{_all}} (items of the type in the current tenant, only on
the non-optimized path), {{_filtered}} (items matching the condition) and
{{_missing}} (items without the field).
* Bucket keys: a range's own key when set, otherwise {{from-to}} with {{*}} for
an open bound. For IP ranges, the key of the range whose bounds match.
* Range bounds: {{from}} is inclusive and {{to}} is exclusive.
The accepted date intervals are not listed either.
h3. Ways to explore
Add an IP range example next to the existing date and numeric range examples, a
short "Reading the results" part covering the keys above, and the list of
accepted date intervals.
> Document IP range aggregates and the special counts in aggregate results
> ------------------------------------------------------------------------
>
> Key: UNOMI-1022
> URL: https://issues.apache.org/jira/browse/UNOMI-1022
> Project: Apache Unomi
> Issue Type: Task
> Reporter: Serge Huber
> Priority: Major
> Fix For: unomi-4.0.0
>
> Time Spent: 10m
> Remaining Estimate: 0h
>
> h3. In short
> The manual does not explain IP range reports or the special totals in report
> results, so integrators have to guess what the numbers mean.
> h3. Details
> * "Queries and aggregations" lists IP range aggregates but has no section for
> them.
> * {{_all}}, {{_filtered}}, {{_missing}}, range bucket keys and bound
> semantics ({{from}} included, {{to}} excluded) are not explained, nor are the
> accepted date intervals.
> h3. Fix
> Add an IP range section, a "Reading the results" section and the list of date
> intervals.
--
This message was sent by Atlassian Jira
(v10.3.26#10030026)
