Skip to content

Commit

Permalink
Merge pull request #395 from amplitude/11-22
Browse files Browse the repository at this point in the history
11 22
  • Loading branch information
markzegarelli authored Nov 22, 2024
2 parents 3129d7b + 97986da commit 2d85ca7
Show file tree
Hide file tree
Showing 528 changed files with 11,539 additions and 6,621 deletions.
538 changes: 268 additions & 270 deletions composer.lock

Large diffs are not rendered by default.

2 changes: 1 addition & 1 deletion content/collections/browser_sdk/en/browser-sdk-2.md
Original file line number Diff line number Diff line change
Expand Up @@ -32,7 +32,7 @@ Install the dependency with npm, yarn, or the script loader.
{{partial:tabs tabs="Script loader, npm, yarn"}}
{{partial:tab name="Script loader"}}
When you use the script loader and enable Autocapture, Browser SDK track interactions on your site automatically. For more information, see [Autocapture](#autocapture).
{{partial:partials/code/snippet autocapture="true"}}
{{partial:partials/code/snippet autocapture="true" unified="true"}}
{{/partial:tab}}
{{partial:tab name="npm"}}
```bash
Expand Down
3 changes: 2 additions & 1 deletion content/collections/data/en/channels.md
Original file line number Diff line number Diff line change
Expand Up @@ -19,7 +19,8 @@ For example, you may want to understand the distribution of organic traffic to y

### Feature availability

This feature is available to users on **Growth** and **Enterprise plans** only.
* Starter and Plus plans can create one classifier.
* Growth and Enterprise plans can create unlimited classifiers.

## Create a channel

Expand Down
20 changes: 12 additions & 8 deletions content/collections/data/en/custom-events.md
Original file line number Diff line number Diff line change
Expand Up @@ -14,13 +14,13 @@ landing: false
---
Sometimes, you may need to create an analysis in which a particular step of the process can be any of a selection of specific events.

It is possible to [combine multiple events in-line](/docs/analytics/charts/event-segmentation/event-segmentation-in-line-events) through the Events Module, however, the in-line event that you create will only be relevant to that specific chart and will not be accessible anywhere else unless it is saved as a **custom event**A custom event is made up of two separate events joined by an `OR` clause. For example, this analysis is interested in users who, after receiving a push notification, **either** played a song **or** searched for one as their next step: 
You can [combine multiple events in-line](/docs/analytics/charts/event-segmentation/event-segmentation-in-line-events) through the Events Module. However, the in-line event that you create is relevant to that specific chart and isn't accessible anywhere else unless you save it as a **custom event**Custom events consist of two separate events joined by an `OR` clause. For example, this analysis shows in users who, after receiving a push notification, either played a song **or** searched for one as their next step: 

![customEvent_funnel.png](/docs/output/img/data/customevent-funnel-png.png)

You create a custom event in the *Events* panel from one or more pre-existing events. Doing so tells Amplitude to combine for those pre-existing events and count any user activity for them as activity for the new custom event. This is useful if you want an easy way to track overall activity on related or similar events, like whether a visitor has fired either the `view_landing_page_1` or `view_landing_page_2` events.
You create a custom event in the *Events* panel from one or more pre-existing events. Doing so tells Amplitude to combine for those pre-existing events and count any user activity for them as activity for the new custom event. This is useful if you want an easy way to track activity on related or similar events, like whether a visitor has fired either the `view_landing_page_1` or `view_landing_page_2` events.

In the image above, `Play or Search Song` is a custom event consisting of the `Play Song` event, the `Search Song` event, and an `OR` clause to connect the two. Any user who triggers **either** the `Play Song` event **or** the `Search Song` event is considered to have **converted** that second step.
In the image above, `Play or Search Song` is a custom event consisting of the `Play Song` event, the `Search Song` event, and an `OR` clause to connect the two. Any user who triggers either the `Play Song` event **or** the `Search Song` event has converted that second step.

Another method is conditioning an added event with an [event property or user property](/docs/data/user-properties-and-events). This is the primary method for analyzing if a user had performed one of many events.

Expand All @@ -32,10 +32,10 @@ This feature is available to users on **Plus**, **Growth**, and **Enterprise** *

* Only admins, managers, and members can create custom events.
* Custom events are available only in the Event Segmentation, Funnel Analysis, Retention Analysis, Lifecycle, Stickiness, Impact Analysis, Pathfinder, and Compass charts.
* You cannot query on custom events in Redshift.
* All custom events will have the prefix `[Custom]` before the event name in your charts.
* Editing or renaming custom events being used on other charts will break those charts. Amplitude will continue to query the previously-named value until it is manually changed on any charts that use it. You will receive a warning when making any edits to custom events.
* Querying event properties on custom events will **only** be possible if the property is applicable to all events. If you're trying to create a custom event with five different events, and you'd like to see the location values from all of those events, you'll need to instrument the location event property to **all** the individual events making up the custom event.
* You can't query on custom events in Redshift.
* All custom events have the prefix `[Custom]` before the event name in your charts.
* Editing or renaming custom events used in other charts break those charts. Amplitude continues to query the named value until you manually change it on any charts that use it. Amplitude displays a warning when making any edits to custom events.
* Querying event properties on custom events is possible only if the property applies to all events. If you try to create a custom event with five different events, and you want to see the location values from all those events, you need to instrument the location event property to all the individual events making up the custom event.

## Group two existing events into a single custom event

Expand All @@ -47,4 +47,8 @@ To do this, follow these steps:

![create_customEvent.png](/docs/output/img/data/create-customevent-png.png)

At this point, this event is available for further analyses in Amplitude. To use it, select the newly-created event in the *Custom* category in the appropriate chart drop-down menus.
At this point, this event is available for further analyses in Amplitude. To use it, select the new event in the *Custom* category in the appropriate chart drop-down menus.

## Custom events and transformed events

{{partial:partials/custom-vs-transformed-events}}
13 changes: 12 additions & 1 deletion content/collections/data/en/data-access-control.md
Original file line number Diff line number Diff line change
Expand Up @@ -29,7 +29,6 @@ With DAC enabled, Amplitude hides properties that you classify from the Event St

The same restrictions apply to Ask Amplitude.


## Set access for specific categories of sensitive data

Setting access levels is a two-stage process. First, **classify** your data. When that’s complete, you can set up **permissions**.
Expand Down Expand Up @@ -74,6 +73,8 @@ Update user and group access from the Overview page, or navigate to Data to upda

Use the project switcher to see classifications for each project, and click *Classify Data* to open that project's tracking plan, where you can manually classify properties.

To customize the error message that your internal users see when they try to access a restricted chart or cohort, click **Customize Restricted Access Message**. On the resulting modal, edit the error message and include any links to internal documentation that may be helpful.

## Notifications

Users who navigate to a restricted chart or cohort have the option to contact an administrator in their organization to request access. Amplitude sends this request to all organization administrators.
Expand All @@ -82,6 +83,16 @@ Users who navigate to a restricted chart or cohort have the option to contact an
Administrators can deselect the `Someone requests access to a property classified by Data Access Controls` notification in *Personal Settings > Notifications* to opt out of these notifications.
{{/partial:admonition}}

## Exports and subscriptions

DAC enforcement applies to all exports and subscriptions in Amplitude. This means:

* If a user clicks **Download Users** from the [microscope](/docs/analytics/microscope) in a chart, the CSV export excludes properties with classifications they can't access.
* If a user tries to export a CSV from a dashboard, the export excludes charts they can't access.
* If a user tries to export a PDF or PNG from a dashboard, the export obfuscates charts and cohorts they can't access.
* If a user tries to subscribe to a chart they can't access, Amplitude cancels the subscription and the user doesn't get a notification or email.
* If a user tries to subscribe to or create alerts for a dashboard, the email obfuscates the charts and cohorts they can't access.

## Manage classifications with the Taxonomy API

The [Taxonomy API](/docs/apis/analytics/taxonomy) enables you to manage classifications for all your properties, at scale.
6 changes: 5 additions & 1 deletion content/collections/data/en/transformations.md
Original file line number Diff line number Diff line change
Expand Up @@ -118,4 +118,8 @@ To delete your transformation, follow these steps:

![undoTransformation.png](/docs/output/img/data/undotransformation-png.png)

Deleting a transformation **doesn't** delete the original events.
Deleting a transformation **doesn't** delete the original events.

## Transformed events and custom events

{{partial:partials/custom-vs-transformed-events}}
Original file line number Diff line number Diff line change
Expand Up @@ -13,6 +13,10 @@ landing_blurb: 'Extend the analytic power of A/B tests you create in Amplitude E
---
With **Experiment Results**, Amplitude Analytics customers who have invested in a non-Amplitude feature flagging platform, whether third party or homegrown, can now take advantage of Amplitude’s planning, tracking, and analysis tools for Experiment—while still using the A/B tracking data generated by their own feature flagging platform.

## Availability

The Experiment Results chart is available to growth and enterprise plans. For more information, see Amplitude's [pricing page](https://amplitude.com/pricing).

## Before you begin

Prior to using Experiment Results, you’ll need to ensure you’ve **instrumented the metric events** that are relevant to your experiment. Without them, you’ll be unable to create the success metrics and goals that Experiment Results needs to compare each variant in its analysis.
Expand All @@ -25,8 +29,8 @@ There is also an [Experiment Results FAQ article](/docs/faq/experiment-analysis)

To create an A/B test and see the results, follow these steps:

1. Navigate to *Create* > *Chart* > *More* > *Experiment Results*.
2. In the Primary Metric module, click *+ Add Metric* or *+* *Define single-use metric* to begin setting up your primary metric.
1. Navigate to *Create* > *Chart* > *Experiment Results*.
2. In the Metrics module, click *+ Add Metric* or *+* *Define single-use metric* to define your primary metric.
3. If adding a single-use metric, use the drop-down menu to specify the **metric type** in the *Define Metric* fly out panel:

* Unique conversions
Expand Down Expand Up @@ -74,5 +78,5 @@ While the specifics may vary depending on the metric types you’re using, you
These charts are also helpful when [learning from your end-to-end experiment](/docs/feature-experiment/overview)

{{partial:admonition type='note'}}
By default, Amplitude selects the primary metric in experiment results. You can choose a different metric in the *Analysis* module. Click on the metric's name in the metric table to see its results. 
By default, Amplitude selects the primary metric in experiment results. You can choose a different metric in the *Analysis* module. Click the dropdown in the metric table to see its results. 
{{/partial:admonition}}
4 changes: 2 additions & 2 deletions content/collections/get-started/en/autocapture.md
Original file line number Diff line number Diff line change
Expand Up @@ -15,11 +15,11 @@ Starting with version 2.10.0, the Amplitude Browser SDK includes Autocapture to

### Install the Browser SDK

To get started with Autocapture, install the latest version of the Browser SDK ({{sdk_versions:browser}}).
To get started with Autocapture, install the latest version of the Browser SDK ({{sdk_versions:browser}}) with the unified script loader, npm, or yarn.

{{partial:tabs tabs="Script Loader, npm, yarn"}}
{{partial:tab name="Script Loader"}}
{{partial:partials/code/snippet autocapture="true"}}
{{partial:partials/code/snippet autocapture="true" unified="true"}}
{{/partial:tab}}
{{partial:tab name="npm"}}
```bash
Expand Down
2 changes: 1 addition & 1 deletion content/collections/get-started/en/create-a-new-account.md
Original file line number Diff line number Diff line change
Expand Up @@ -16,7 +16,7 @@ Amplitude's onboarding helps you to get data into your new organization as quick

Once you sign up and activate your account, Amplitude prompts you to connect your first application with a single snippet. Enable [Session Replay](/docs/session-replay) and [Autocapture](/docs/data/autocapture) to enable those features automatically.

{{partial:partials/code/snippet autocapture="true" session_replay="true"}}
{{partial:partials/code/snippet autocapture="true" session_replay="true" unified="true"}}

{{partial:admonition type="note" heading="Session Replay sample rate"}}
When you add Session Replay to the snippet, Amplitude sets the Sample Rate to `1`. This ensures you can verify the implementation during testing. In production, Amplitude recommends you set this value lower to account for your monthly quota. For more information, see [Session Replay Plugin | Sampling rate](/docs/session-replay/session-replay-plugin#sampling-rate)
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -75,8 +75,13 @@ When this happens, Session Replay combines the settings from the SDK and the UI,
|SDK settings | UNMASK | | MASK |
|End results | MASK | UNMASK | MASK |

{{partial:admonition type="note" heading="Remote configuration"}}
If remote configuration is enabled, and fails to load, Session Replay doesn't capture any sessions. This ensures that Amplitude respects any privacy settings you define in the Admin interface, and you don't accidentally capture sensitive data.
{{/partial:admonition}}

### CSS selectors

Session Replay's configuration supports many types of [CSS Selector](https://developer.mozilla.org/en-US/docs/Learn/CSS/Building_blocks/Selectors). Specify an element tag (`h1` or `textarea`), a class name (`.hidden`) or a data attribute.

Data attributes may be useful if your class names change often due to hashing. To use data attributes, add a custom attribute like `data-amp-unmask` or `data-amp-mask` to any HTML element. For example, `<textarea data-amp-unmask></textarea>`, then enclose the attribute in square brackets when you specify the selector, `[data-amp-unmask]`.
Data attributes may be useful if your class names change often due to hashing. To use data attributes, add a custom attribute like `data-amp-unmask` or `data-amp-mask` to any HTML element. For example, `<textarea data-amp-unmask></textarea>`, then enclose the attribute in square brackets when you specify the selector, `[data-amp-unmask]`.

2 changes: 1 addition & 1 deletion content/globals/en/sdk_versions.yaml
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
browser: 2.11.7
browser: 2.11.9
visual_labeling_plugin: 1.0.0
session_replay_plugin: 1.8.1
session_replay_standalone: 1.13.8
Expand Down
Original file line number Diff line number Diff line change
@@ -0,0 +1,10 @@
{{markdown}}
| Topic | Custom Events | Transformed Events and Properties |
| --------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------- |
| Analysis of individual components | Can perform analysis on the indivdual events used in the custom event. | Can only perform analysis on the transformed event. |
| Use case | Augment and group existing events into new events which you can analyze. | Cleanup events and fix instrumentation issues. |
| Drop and block filters | Not available to block and drop filters. | Transformed entities aren't available to block and drop filters. |
| Chart UI limitations | Not available in Journeys, Pathfinder, or Conversion Driver charts. Limited availability in Funnels, but can't group by event name. | Available to most charts. |
| User lookup | Shows raw event data only. | Shows raw event data only. |
| Event type limit | Don't count toward the event limit. | Don't count toward the event limit. |
{{/markdown}}
55 changes: 55 additions & 0 deletions resources/views/partials/code/_snippet.antlers.html
Original file line number Diff line number Diff line change
@@ -1,3 +1,57 @@
{{if unified}}
{{if session_replay&&autocapture}}
{{markdown}}
```html
<script src="https://cdn.amplitude.com/script/AMPLITUDE_API_KEY.js"></script>
<script>
window.amplitude.add(window.sessionReplay.plugin({sampleRate: 1}));
window.amplitude.init('AMPLITUDE_API_KEY', {
"fetchRemoteConfig":true, "autocapture":true
});
</script>
```
{{/markdown}}
{{elseif autocapture}}
{{markdown}}
```html
<script src="https://cdn.amplitude.com/script/AMPLITUDE_API_KEY.js"></script>
<script>
window.amplitude.init('AMPLITUDE_API_KEY', {
"fetchRemoteConfig":true, "autocapture":true
});
</script>
```
{{/markdown}}
{{elseif session_replay}}
{{markdown}}
```html
<script src="https://cdn.amplitude.com/libs/analytics-browser-{{sdk_versions.browser}}-min.js.gz"></script>
<script src="https://cdn.amplitude.com/libs/plugin-session-replay-browser-{{sdk_versions.session_replay_plugin}}-min.js.gz"></script>
<script>
window.amplitude.add(window.sessionReplay.plugin({ sampleRate: 1 })).promise.then(function () {
window.amplitude.init("AMPLITUDE_API_KEY");
});
</script>
```
{{/markdown}}
{{else}}
{{markdown}}
```html
<script src="https://cdn.amplitude.com/libs/analytics-browser-{{sdk_versions.browser}}-min.js.gz"></script>
<script>
window.amplitude.init("AMPLITUDE_API_KEY");
</script>
```
{{/markdown}}
{{/if}}
{{else}}
{{if session_replay&&autocapture}}
{{markdown}}
```html
Expand Down Expand Up @@ -50,3 +104,4 @@
{{/markdown}}
{{/if}}
{{/if}}
Original file line number Diff line number Diff line change
Expand Up @@ -24,4 +24,8 @@

Session Replay's configuration supports many types of [CSS Selector](https://developer.mozilla.org/en-US/docs/Learn/CSS/Building_blocks/Selectors). Specify an element tag (`h1` or `textarea`), a class name (`.hidden`) or a data attribute.

Data attributes may be useful if your class names change often due to hashing. To use data attributes, add a custom attribute like `data-amp-unmask` or `data-amp-mask` to any HTML element. For example, `<textarea data-amp-unmask></textarea>`, then enclose the attribute in square brackets when you specify the selector, `[data-amp-unmask]`.
Data attributes may be useful if your class names change often due to hashing. To use data attributes, add a custom attribute like `data-amp-unmask` or `data-amp-mask` to any HTML element. For example, `<textarea data-amp-unmask></textarea>`, then enclose the attribute in square brackets when you specify the selector, `[data-amp-unmask]`.

{{partial:admonition type="note" heading="Remote configuration"}}
If remote configuration is enabled, and fails to load, Session Replay doesn't capture any sessions. This ensures that Amplitude respects any privacy settings you define in the Admin interface, and you don't accidentally capture sensitive data.
{{/partial:admonition}}
Loading

0 comments on commit 2d85ca7

Please sign in to comment.