Skip to content

Commit dd5d0f5

Browse files
authored
Merge pull request #7436 from umbraco/engage-images
Updated more images
2 parents 8383cb9 + a734582 commit dd5d0f5

File tree

12 files changed

+28
-29
lines changed

12 files changed

+28
-29
lines changed
1.38 KB
Loading
125 KB
Loading
1 MB
Loading
163 KB
Loading
30 KB
Loading
114 KB
Loading
-16.8 KB
Loading

16/umbraco-engage/developers/analytics/scroll-heatmap.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -8,4 +8,4 @@ description: >-
88

99
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.
1010

11-
![View a scroll heatmap on each published content item in the Content section.](../../.gitbook/assets/engage-analytics-scroll-heatmap-2.png)
11+
![View a scroll heatmap on each published content item in the Content section.](../../.gitbook/assets/engage-analytics-scroll-heatmap-2-v16.png)

16/umbraco-engage/developers/headless/using-the-marketing-api.md

Lines changed: 20 additions & 20 deletions
Original file line numberDiff line numberDiff line change
@@ -59,16 +59,16 @@ The settings can be changed at runtime without restarting the website for these
5959

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

62-
`/umbraco/engage/api/v1/analytics/pageview/trackpageview/client`
62+
* `/umbraco/engage/api/v1/analytics/pageview/trackpageview/client`
6363

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

67-
`/umbraco/engage/api/v1/analytics/pageview/trackpageview/server`
67+
* `/umbraco/engage/api/v1/analytics/pageview/trackpageview/server`
6868

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

7373
Both API endpoints will return the following response:
7474

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

9393
To track events, send a POST request to:
9494

95-
`/umbraco/engage/api/v1/analytics/pageevent/trackpageevent`
95+
* `/umbraco/engage/api/v1/analytics/pageevent/trackpageevent`
9696

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

100100
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.
101101

102102
### Segmentation - Assets
103103

104-
`/umbraco/engage/api/v1/segmentation/assets/item/{path}` 
104+
* `/umbraco/engage/api/v1/segmentation/assets/item/{path}`
105105

106-
`/umbraco/engage/api/v1/segmentation/assets/item/{id}`
106+
* `/umbraco/engage/api/v1/segmentation/assets/item/{id}`
107107

108108
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:
109109

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

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

123123
### Segmentation - Content
124124

125-
`/umbraco/engage/api/v1/segmentation/content/segments` 
125+
* `/umbraco/engage/api/v1/segmentation/content/segments`
126126

127-
`/umbraco/engage/api/v1/segmentation/content/segments/{path}`
127+
* `/umbraco/engage/api/v1/segmentation/content/segments/{path}`
128128

129-
 `/umbraco/engage/api/v1/segmentation/content/segments/{id}`
129+
* `/umbraco/engage/api/v1/segmentation/content/segments/{id}`
130130

131131
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:
132132

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

167167
### Segmentation - Visitor
168168

169-
`/umbraco/engage/api/v1/segmentation/content/activesegments/{path}`
169+
* `/umbraco/engage/api/v1/segmentation/content/activesegments/{path}`
170170

171-
 `/umbraco/engage/api/v1/segmentation/content/activesegments/{id}`
171+
* `/umbraco/engage/api/v1/segmentation/content/activesegments/{id}`
172172

173-
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. 
173+
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.
174174

175175
This returns the following response:
176176

@@ -199,7 +199,7 @@ This returns the following response:
199199

200200
### Cookies & External Visitor IDs
201201

202-
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. 
202+
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.
203203

204204
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.
205205

16/umbraco-engage/developers/profiling/external-profile-data.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -18,7 +18,7 @@ It is possible to visualize this external data alongside the Umbraco Engage prof
1818

1919
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.
2020

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

2323
### Register custom components
2424

0 commit comments

Comments
 (0)