docs: merge latest docs and changelog

CHANGELOG.md

@@ -5,6 +5,25 @@ All notable changes to this project will be documented in this file.
 The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/),
 and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).
 
+## [1.1.6] - 2024-05-24
+
+### Updated
+
+* optimize data schema to improve query performance in Explorations, Analyzes, and ad-hoc query
+* support automatic traffic source detection, classification, and dashboard
+* revamp out-of-the-box dashboard
+* support timezone in out-of-the-box dashboard
+* add more metric types to Event analysis
+* support "show all nodes" in Path analysis
+* add new analysis model - attribution analysis in Exploration
+* support using internal load balancer as the ingestion endpoint
+* improve stability of loading data into Redshift
+* add React Native SDK
+
+### Fixed
+
+* inconsistent pipeline status in edge cases
+
 ## [1.1.5] - 2024-03-08
 
 ### Updated

docs/en/analytics/analyzes/index.md

@@ -21,20 +21,12 @@ Analyzes module is essentially the author interface of QuickSight, in which you
     Only the user with `Administrator` or `Analyst` role can access this module.
 
 
-
-The solution automatically added the following datasets for each project and app:
+The solution automatically added the following datasets for each project and app, which contains all fields of event, user, and session tables, making it easy for you do custom analysis.
 
 | Dataset name | What it is |
 |-------------|------------|
-|Event_View_`app_name`_`project_name`| Event data that includes all public event parameters |
-|Event_Parameter_View_`app_name`_`project_name`| Events data that includes all private event parameters|
-|User_Dim_View_`app_name`_`project_name`| User data that includes all public attributes|
-|User_Attr_View_`app_name`_`project_name`| User data that includes all private(custom) attributes|
-|Session_View_`app_name`_`project_name`| Data contains measures and dimension about session|
-|Device_View_`app_name`_`project_name`| Data contains information about user device|
-|Retention_View_`app_name`_`project_name`| Data provides metrics on total users and returned user for each date|
-|Lifecycle_Weekly_View_`app_name`_`project_name`| User lifecycle metrics for every week|
-|Lifecycle_Daily_View_`app_name`_`project_name`| User lifecycle metrics for every date|
+|Event_View_`app_name`_`project_name`| Event data that includes all event parameters (both common and custom) that joined with user and session table.  |
+
 
 
 To create a custom analysis, you can follow below QuickSight documentation to prepare data and create visualization:

docs/en/analytics/dashboard/acquisition.md

@@ -1,5 +1,5 @@
 # Acquisition report
-You can use the User acquisition report to get insights into how new users find your website or app for the first time. This report also allows you view the detail user profile.
+You can use the acquisition report to get insights into how new users arrive at your website or app for the first time, as well as the sources of everyday traffic. 
 
 Note: This article describes the default report. You can customize the report by applying filters or comparisons or by changing the dimensions, metrics, or charts in QuickSight. [Learn more](https://docs.aws.amazon.com/quicksight/latest/user/working-with-visuals.html)
 
@@ -8,14 +8,50 @@ Note: This article describes the default report. You can customize the report by
 1. Access the dashboard for your application. Refer to [Access dashboard](index.md/#view-dashboards)
 2. In the dashboard, click on the sheet with name of **`Acquisition`**.
 
-## Where the data comes from
-
-## Dimensions and metrics
-The report includes the following dimensions and metrics. You can add more dimensions or metrics by creating `calculated field` in QuickSight dateset. [Learn more](https://docs.aws.amazon.com/quicksight/latest/user/adding-a-calculated-field-analysis.html). 
-
-|Field | Type| What is it | How it's populated|
-|----------|---|---------|--------------------|
-
+## Data sources
+Acquisition report is created based on the following QuickSight datasets:
+
+|QuickSight dataset | Redshift view / table| Description | 
+|----------|--------------------|------------------|
+|`User_User_View-<app>-<project>`|`clickstream_acquisition_day_user_view_cnt` | This dataset stores data on the number of new users and number of active users on your websites or apps for each day|
+|`Day_Traffic_Source_User-<app>-<project>`|`clickstream_acquisition_day_traffic_source_user`|This dataset stores data on the number of new users per each traffic source type for each day|
+|`Day_User_Acquisition-<app>-<project>`|`clickstream_acquisition_day_user_acquisition` |This dataset stores data on the number of new users, number of active users, number of sessions, number of engaged sessions, and number of events per each traffic source type for each day |
+|`Country_New_User_Acquisition-<app>-<project>`|`clickstream_acquisition_country_new_user`|This dataset stores data on the number of new users per each country and city for each day|
+
+
+## Dimensions
+The Acquisition report includes the following dimensions.
+
+|Dimension | Description| How it's calculated| 
+|----------|--------------------|---------|
+| First user traffic source | The source of the traffic that acquires new users to your websites or apps (for example, google, baidu, and bing)  | Traffic source is populated from utm parameters in page_url (i.e., utm_source) or traffic-source preserved attribute (i.e., _traffic_source_source), or derived from referrer url (only for web). [Learn more](../data-mgmt/traffic-source.md)|
+| First user traffic medium | The medium of the traffic that acquires new users to your websites or apps (for example, organic, paid search)  | Traffic medium is populated from utm parameters in page_url (i.e., utm_medium) or traffic-source preserved attribute (i.e., _traffic_source_medium), or derived from referrer url (only for web). [Learn more](../data-mgmt/traffic-source.md)|
+| First user traffic campaign | The name of a promotion or marketing campaign that acquires new users to your websites or apps.  | Traffic campaign is populated from utm parameters in page_url (i.e., utm_campaign) and traffic-source preserved attribute (i.e., _traffic_source_campaign), or derived from referrer url (only for web). [Learn more](../data-mgmt/traffic-source.md)|
+| First user traffic source / Medium | The combination of traffic source and medium that acquires new users to your websites or apps.  | Same as above for traffic source and traffic medium. [Learn more]()|
+| First user traffic channel group | Channel groups are rule-based definitions of the traffic sources. The name of the traffic channel group that acquires new users to your websites or apps.  | Traffic channel group is derived based on the traffic source and medium. [Learn more](../data-mgmt/traffic-source.md)|
+| First user traffic clid platform | The name of platform for click id (auto-tagging from advertisement platform) that acquires new users to your websites or apps.  | Traffic source clid platform is populated from clid parameter in page_url and traffic-source preserved attribute (i.e., _traffic_source_clid_platform). [Learn more](../data-mgmt/traffic-source.md)|
+| First user app install source | The name of app store that acquires new users to your apps, for example, App Store, Google Store.  | App install source is from traffic-source preserved attribute (i.e., _app_install_channel). [Learn more](../data-mgmt/traffic-source.md)|
+| Session traffic source | The traffic source that acquires users into a new session on your websites or apps (for example, google, baidu, and bing)  | Traffic source is populated from utm parameters in page_url (i.e., utm_source) or traffic-source preserved attribute (i.e., _traffic_source_source), or derived from referrer url (only for web). [Learn more](../data-mgmt/traffic-source.md)|
+| Session traffic medium | The traffic medium that acquires users into a new session on your websites or apps (for example, organic, paid search)  | Traffic medium is populated from utm parameters in page_url (i.e., utm_medium) or traffic-source preserved attribute (i.e., _traffic_source_medium), or derived from referrer url (only for web). [Learn more](../data-mgmt/traffic-source.md)|
+| Session traffic campaign | The name of a promotion or marketing campaign that acquires users into a new session on your websites or apps.  | Traffic campaign is populated from utm parameters in page_url (i.e., utm_campaign) and traffic-source preserved attribute (i.e., _traffic_source_campaign), or derived from referrer url (only for web). [Learn more](../data-mgmt/traffic-source.md)|
+| Session traffic Source / Medium | The combination of traffic source and medium that acquires users into a new session on your websites or apps.  | Same as above for traffic source and traffic medium. [Learn more](../data-mgmt/traffic-source.md)|
+| Session traffic channel group | Channel groups are rule-based definitions of the traffic sources. The name of the traffic channel group that acquires users into a new session on your websites or apps.  | Traffic channel group is derived based on the traffic-source and medium. [Learn more](../data-mgmt/traffic-source.md)|
+|Session traffic clid platform | The name of platform for click id (auto-tagging from advertisement platform) that acquires users into new session on your websites or apps.  | Traffic clid platform is populated from clid parameter in page_url and traffic-source preserved attribute (i.e., _traffic_source_clid_platform). [Learn more](../data-mgmt/traffic-source.md)|
+|Geo country| The country where users are when they are using your websites or apps  | Geo location information is inferred based on user IP address.|
+|Geo city| The city where the users are when they are using your websites or apps  | Geo location information is inferred based on user IP address.|
+
+## Metrics
+The Acquisition report includes the following metrics.
+
+|Metric | Definition| How it's populated| 
+|----------|--------------------|---------|
+| New users |The number of users who interacted with your site or launched your app for the first time (event triggered: _first_open).| Count distinct user_id or user_pseudo_id (if user_id is not available) when event_name equals '_first_open'.|
+| Active users | The number of distinct users who triggered any event in the selected time range.| Count distinct user_id or user_pseudo_id (if user_id is not available) at any event| 
+| Sessions | The number of sessions users created.| Count distinct session_id. |
+| Engaged Session | The number of sessions that lasted 10 seconds or longer, or had 1 or more page or screen views.| Count distinct session_id if the session is engaged. |
+| Engaged Rate | The percentage of sessions that were engaged sessions.| Engaged sessions / total sessions. |
+| Events | The number of times users triggered an event.| Count event_id. |
+| Avg_engagement_time_per_user | The average time per user that your website was in focus in a user's browser or an app was in the foreground of a user's device.| Total user engagement durations / Number of active users |
 
 ## Sample dashboard
 Below image is a sample dashboard for your reference.