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
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file modified 16/umbraco-engage/.gitbook/assets/image (13).png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
2 changes: 1 addition & 1 deletion 16/umbraco-engage/developers/analytics/scroll-heatmap.md
Original file line number Diff line number Diff line change
Expand Up @@ -8,4 +8,4 @@ description: >-

The heatmap only collects data if [the client-side script](client-side-events-and-additional-javascript-files/additional-measurements-with-the-analytics-scripts.md) is installed on your website.

![View a scroll heatmap on each published content item in the Content section.](../../.gitbook/assets/engage-analytics-scroll-heatmap-2.png)
![View a scroll heatmap on each published content item in the Content section.](../../.gitbook/assets/engage-analytics-scroll-heatmap-2-v16.png)
40 changes: 20 additions & 20 deletions 16/umbraco-engage/developers/headless/using-the-marketing-api.md
Original file line number Diff line number Diff line change
Expand Up @@ -59,16 +59,16 @@ The settings can be changed at runtime without restarting the website for these

To track a page view, send a POST request to:

`/umbraco/engage/api/v1/analytics/pageview/trackpageview/client`
* `/umbraco/engage/api/v1/analytics/pageview/trackpageview/client`

* Required: `url` property of the page that a user has visited in the site
* Optional: `reffererUrl` can be set to inform Umbraco Engage where the user came from.
* Required: `url` property of the page that a user has visited in the site
* Optional: `reffererUrl` can be set to inform Umbraco Engage where the user came from.

`/umbraco/engage/api/v1/analytics/pageview/trackpageview/server`
* `/umbraco/engage/api/v1/analytics/pageview/trackpageview/server`

* Useful when a frontend JAMStack Server such as a NuxtJS server or similar is being used.
* Can notify Umbraco Engage when a page view has taken place and provide extra information.
* Requests extra metadata like `headers`, `browserUserAgent`, `remoteClientAddress`, and `userIdentifier`.
* Useful when a frontend JAMStack Server such as a NuxtJS server or similar is being used.
* Can notify Umbraco Engage when a page view has taken place and provide extra information.
* Requests extra metadata like `headers`, `browserUserAgent`, `remoteClientAddress`, and `userIdentifier`.

Both API endpoints will return the following response:

Expand All @@ -92,18 +92,18 @@ Umbraco Engage gathers information about visitors based on their requests, extra

To track events, send a POST request to:

`/umbraco/engage/api/v1/analytics/pageevent/trackpageevent`
* `/umbraco/engage/api/v1/analytics/pageevent/trackpageevent`

* After tracking a pageview using the Analytics TrackPageview API as mentioned above, you will receive both an externalVisitorId and `pageviewId`.
* Requires a supplied pageview-Id header and a request body containing a `category`, `action` _(optional)_, `label` _(optional)_, and `timestamp` _(optional)_.
* After tracking a pageview using the Analytics TrackPageview API as mentioned above, you will receive both an externalVisitorId and `pageviewId`.
* Requires a supplied pageview-Id header and a request body containing a `category`, `action` _(optional)_, `label` _(optional)_, and `timestamp` _(optional)_.

Optionally, provide an External-Visitor-Id header in order to automatically update the in-memory visitor. This helps to automatically reflect segments involving events for said visitors. Without this parameter, the pageview must be flushed to the database (according to the configuration) before any segment-related information is updated. For example: personalization variants based on events.

### Segmentation - Assets

`/umbraco/engage/api/v1/segmentation/assets/item/{path}` 
* `/umbraco/engage/api/v1/segmentation/assets/item/{path}`

`/umbraco/engage/api/v1/segmentation/assets/item/{id}`
* `/umbraco/engage/api/v1/segmentation/assets/item/{id}`

These requests let you verify if a content page has a **JavaScript** or **CSS** variant available for page injection for this specific visitor. This endpoint requires the External-Visitor-Id header to function. This returns the following response:

Expand All @@ -118,15 +118,15 @@ These requests let you verify if a content page has a **JavaScript** or **CSS**
}
```

![Add custom code for variant](../../.gitbook/assets/engage-headless-segment-css.png)
![Add custom code for variant](../../.gitbook/assets/engage-headless-segment-css-v16.png)

### Segmentation - Content

`/umbraco/engage/api/v1/segmentation/content/segments` 
* `/umbraco/engage/api/v1/segmentation/content/segments`

`/umbraco/engage/api/v1/segmentation/content/segments/{path}`
* `/umbraco/engage/api/v1/segmentation/content/segments/{path}`

 `/umbraco/engage/api/v1/segmentation/content/segments/{id}`
* `/umbraco/engage/api/v1/segmentation/content/segments/{id}`

These requests return details about segments (personalization and A/B testing) configured for a page. This helps determine if content can be changed by Umbraco Engage or cached more aggressively. The information returned by the APIs is visitor agnostic and reflects all the segments as configured in Umbraco. This returns the following response:

Expand Down Expand Up @@ -166,11 +166,11 @@ These requests return details about segments (personalization and A/B testing) c

### Segmentation - Visitor

`/umbraco/engage/api/v1/segmentation/content/activesegments/{path}`
* `/umbraco/engage/api/v1/segmentation/content/activesegments/{path}`

 `/umbraco/engage/api/v1/segmentation/content/activesegments/{id}`
* `/umbraco/engage/api/v1/segmentation/content/activesegments/{id}`

These requests return the segment (personalization and A/B testing) that the current visitor ID of that specific page belongs to. This endpoint requires the External-Visitor-Id header to function. 
These requests return the segment (personalization and A/B testing) that the current visitor ID of that specific page belongs to. This endpoint requires the External-Visitor-Id header to function.

This returns the following response:

Expand Down Expand Up @@ -199,7 +199,7 @@ This returns the following response:

### Cookies & External Visitor IDs

Umbraco Engage in a non-headless setup uses cookies to track returning visitors. This, however, has proven difficult to work with in a headless setup for most clients. Therefore, it is not a recommended way of working with the Engage API. 
Umbraco Engage in a non-headless setup uses cookies to track returning visitors. This, however, has proven difficult to work with in a headless setup for most clients. Therefore, it is not a recommended way of working with the Engage API.

Each API endpoint that allows for tracking analytics, segmentation, and retrieving content has support for adding the External Visitor ID header. This is a unique ID for an individual visitor and is to be used instead of the cookie. When tracking pageviews, a new External Visitor ID will be generated and is to be used for subsequent API calls corresponding to that visitor.

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -18,7 +18,7 @@ It is possible to visualize this external data alongside the Umbraco Engage prof

When this component is registered a new tab will be rendered in the Profiles section when viewing profile details. This will render the custom component that was provided and get passed the Umbraco Engage visitor ID.

<figure><img src="../../.gitbook/assets/image (18).png" alt="External profile data tab"><figcaption><p>External profile data tab</p></figcaption></figure>
![External profile data tab.](../../.gitbook/assets/External-profile-data-tab-v16.png)

### Register custom components

Expand Down
9 changes: 5 additions & 4 deletions 16/umbraco-engage/installation/troubleshooting-installs.md
Original file line number Diff line number Diff line change
Expand Up @@ -30,7 +30,7 @@ Is the **Umbraco Engage Cockpit tool** visible on the front end of your site **a

No? Ensure you are logged in to Umbraco and that the [Cockpit Partial view](../getting-started/for-developers/cockpit.md) is added automatically in your main template.

![Umbraco Engage Cockpit tool](../.gitbook/assets/engage-cockpit-1.png)
![Umbraco Engage Cockpit tool](../.gitbook/assets/engage-cockpit-v16.png)

### 4. Cockpit Client-Side Data

Expand All @@ -50,7 +50,7 @@ Go to **Engage** -> **Settings** -> **Create a new goal**. Do you see the follow

![Umbraco Forms Submission option in Goal dropdown](../.gitbook/assets/engage-forms-goal-type.png)

If you see both options, Umbraco Forms has been configured correctly. If not, ensure that your development team has installed the additional Umbraco Engage [UmbracoForms NuGet package](https://www.nuget.org/packages/Umbraco.Engage.Forms).
If you see both options, Umbraco Forms has been configured correctly. If not, ensure that your development team has installed the additional [Umbraco.Engage.Forms NuGet package](https://www.nuget.org/packages/Umbraco.Engage.Forms).

### 6. Analytics

Expand All @@ -62,12 +62,13 @@ Are you able to see analytical data? If not, then you **need to wait 24 hours fo

Do you only see **\<unknown>** in the Location tab of Analytics?

This means that additional configuration is required. Get in touch with a developer, as they need to [work to set up and track visitor locations by country and city](../developers/analytics/extending-analytics/getting-the-correct-ip-address.md).\
This means that additional configuration is required. Get in touch with a developer, as they need to [work to set up and track visitor locations by country and city](../developers/analytics/extending-analytics/getting-the-correct-ip-address.md).

There is also a [community package](https://github.com/hjaltedaniel-umbraco/Umbraco.Community.Engage.LocationHeaders) that will collect locations and add them to the Analytics section.

Once set up, you will see analytics for countries like this below:

<figure><img src="../.gitbook/assets/image (1).png" alt=""><figcaption></figcaption></figure>
![Locations](../.gitbook/assets/analytics-locations-v16.png)

### 8. Set up IP Filters

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -40,13 +40,11 @@ To personalize a specific page:
8. Click **Save**.
9. A split-view editor opens up, where you can create a personalized variant on the right side of the original page.

![Split-view editor with options to create a personalized variant for the selected segment](../../.gitbook/assets/engage-personalization-splitview-text.png)

10. Edit specific properties of your Document Type depending on your segmentation setup. To set this up correctly, see the [Setting up the Document Type for splitview editing](../ab-testing/types-of-ab-tests/single-page-ab-test.md) article.

For example, you can specify a different title for this variant:

![Editing a personalized variant with a different title in the splitview editor](../../.gitbook/assets/engage-my-first-personalization.png)
![Split-view editor with options to create a personalized variant for the selected segment.](../../.gitbook/assets/engage-personalization-splitview-text-v16.png)

11. Click **Save & Preview** to save and preview your applied personalization.

Expand Down