Skip to content

Commit 000deb1

Browse files
Sofie Toft Kristensengitbook-bot
authored andcommitted
GITBOOK-64: No subject
1 parent 0c1f55c commit 000deb1

File tree

9 files changed

+20
-24
lines changed

9 files changed

+20
-24
lines changed
30.7 KB
Loading
38.6 KB
Loading
8.33 KB
Loading
11.2 KB
Loading
9.35 KB
Loading

13/umbraco-ums/developers/headless/README.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -70,4 +70,4 @@ To update the Startup.cs file, follow these steps:
7070
5. Navigate to **/umbraco/swagger** in your browser.
7171
6. From the top right definition dropdown, check for the **uMarketingSuite Marketing API.**
7272

73-
![]()
73+
**MISSING IMAGE**

13/umbraco-ums/developers/headless/using-the-marketing-api.md

Lines changed: 15 additions & 19 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,7 @@
11
---
22
description: >-
3-
Learn how to use the Headless API to track page views, personalize content, and manage segmentation for visitors.
3+
Learn how to use the Headless API to track page views, personalize content,
4+
and manage segmentation for visitors.
45
---
56

67
# Using the Marketing API
@@ -59,54 +60,49 @@ To track a page view, send a POST request to:
5960

6061
`/umbraco/umarketingsuite/api/v1/analytics/pageview/trackpageview/client`
6162

62-
- Required: `url` property of the page that a user has visited in the site
63-
- Optional: `reffererUrl` can be set to inform uMarketingSuite where the user came from.
63+
* Required: `url` property of the page that a user has visited in the site
64+
* Optional: `reffererUrl` can be set to inform uMarketingSuite where the user came from.
6465

6566
`/umbraco/umarketingsuite/api/v1/analytics/pageview/trackpageview/server`
6667

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

7172
**Client and Server**
7273

7374
uMarketingSuite gathers information about visitors based on their requests, extracting details from your request like HTTPContext.
7475

75-
- **Client-side**: This version applies when you make an API call directly to Umbraco from your browser. In this case, all the request metadata, such as IP address, cookies, request headers, and so on, comes directly from your browser.
76-
77-
- **Server-side**: If there is a server between the browser and Umbraco, like a NuxtJS server, the requests tracked are from the server rather than the browser. In this scenario, uMarketingSuite does not receive metadata from the end-client's requests. Instead, you can use the server version to add this additional metadata (headers, IP addresses, and so on) to your pageview tracking between the NuxtJS server and Umbraco.
76+
* **Client-side**: This version applies when you make an API call directly to Umbraco from your browser. In this case, all the request metadata, such as IP address, cookies, request headers, and so on, comes directly from your browser.
77+
* **Server-side**: If there is a server between the browser and Umbraco, like a NuxtJS server, the requests tracked are from the server rather than the browser. In this scenario, uMarketingSuite does not receive metadata from the end-client's requests. Instead, you can use the server version to add this additional metadata (headers, IP addresses, and so on) to your pageview tracking between the NuxtJS server and Umbraco.
7878

7979
### Page Events
8080

8181
To track events, send a POST request to:
8282

8383
`/umbraco/umarketingsuite/api/v1/analytics/pageevent/trackpageevent`
8484

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

8888
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.
8989

9090
### Segmentation - Assets
9191

92-
`/umbraco/umarketingsuite/api/v1/segmentation/assets/item/{path}`
93-
`/umbraco/umarketingsuite/api/v1/segmentation/assets/item/{id}`
92+
`/umbraco/umarketingsuite/api/v1/segmentation/assets/item/{path}` `/umbraco/umarketingsuite/api/v1/segmentation/assets/item/{id}`
9493

9594
These requests let you verify if a content page, by ID or Path, has a **JavaScript** or **CSS** variant available for page injection.
9695

97-
![]()
96+
![](../../.gitbook/assets/engage-headless-segment-css.png)
9897

9998
### Segmentation - Content
10099

101-
`/umbraco/umarketingsuite/api/v1/segmentation/content/segments`
102-
`/umbraco/umarketingsuite/api/v1/segmentation/content/segments/{path}`
103-
`/umbraco/umarketingsuite/api/v1/segmentation/content/segments/{id}`
100+
`/umbraco/umarketingsuite/api/v1/segmentation/content/segments` `/umbraco/umarketingsuite/api/v1/segmentation/content/segments/{path}` `/umbraco/umarketingsuite/api/v1/segmentation/content/segments/{id}`
104101

105102
These requests return details about segments (personalization and A/B testing) configured for a page. This helps determine if content can be changed by uMarketingSuite or cached more aggressively.
106103

107104
### Segmentation - Visitor
108105

109-
`/umbraco/umarketingsuite/api/v1/segmentation/content/activesegments/{path}`
110-
`/umbraco/umarketingsuite/api/v1/segmentation/content/activesegments/{id}`
106+
`/umbraco/umarketingsuite/api/v1/segmentation/content/activesegments/{path}` `/umbraco/umarketingsuite/api/v1/segmentation/content/activesegments/{id}`
111107

112108
These requests return the segment (personalization and A/B testing) that the current visitor ID of that specific page belongs to based on its cookie.

13/umbraco-ums/developers/settings/custom-goals-scoring.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -18,7 +18,7 @@ To set custom goals:
1818

1919
Creating the goal is similar to creating a page view or page event goal. The **goal ID** displayed in the code snippet after saving, as it's needed to trigger the goal from the code.
2020

21-
![goal id]()
21+
![goal id](../../.gitbook/assets/engage-custom-goal-ID.png)
2222

2323
## Trigger goal in C\#
2424

13/umbraco-ums/marketers-and-editors/personalization/implicit-and-explicit-personalization/implicit-personalization-scoring-explained.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -26,20 +26,20 @@ The points of all these different sources are added and this reaches a certain a
2626

2727
In the example, the visitor collected 40 points for the "**Data & Privacy officer**", 30 points for the "**Marketer**", and 0 points for the developer persona:
2828

29-
![]()
29+
![](../../../.gitbook/assets/engage-persona-scoring.png)
3030

3131
The threshold in this specific case was set to 25 points. As soon as the "**Data & Privacy officer**" reached 25 points Umbraco uMS assumed that this visitor was a "**Data & Privacy officer**".
3232

3333
In this example the "**Think**" customer journey step is assumed based on the collected amount of points:
3434

35-
![]()
35+
![](../../../.gitbook/assets/engage-journey-scoring.png)
3636

3737
## Tweaking the scoring
3838

3939
The threshold value and the expected difference between two personas or journey steps can be set in the [customer journey group](setting-up-the-customer-journey.md) and [persona group](setting-up-personas.md).
4040

4141
Setting up a deviation of at least 35 points between two personas the cockpit will show a different visualization in the previous example:
4242

43-
![]()
43+
![](../../../.gitbook/assets/engage-persona-scoring-with-minimal-deviation.png)
4444

4545
You can see that the "**Data and privacy officer**" still has 40 points and the marketer 30 points. Both have also reached the threshold of 25 points, but there is not a minimal deviation of 35 points. Umbraco uMS algorithm now does not assume a persona yet, but will wait until the deviation is big enough (according to the settings) and the "**Data & privacy officer**" reaches 65 points **(30 points of the marketer + a minimal deviation of 35 points)**.

0 commit comments

Comments
 (0)