Skip to content

Commit 818fd9c

Browse files
eshanrnhgitbook-bot
authored andcommitted
GITBOOK-41: Fixed formatting
1 parent 3303779 commit 818fd9c

File tree

6 files changed

+99
-101
lines changed

6 files changed

+99
-101
lines changed

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

Lines changed: 25 additions & 31 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,7 @@
11
---
22
description: >-
3-
This article shows how to personalize content using the uMarketingSuite Headless API and Umbraco’s Content Delivery API.
3+
This article shows how to personalize content using the uMarketingSuite
4+
Headless API and Umbraco’s Content Delivery API.
45
---
56

67
# Headless Example
@@ -12,12 +13,12 @@ This article shows how to use the uMarketingSuite Headless API with Umbraco Cont
1213
1. Go to the **Marketing** > **Personalization** section.
1314
2. Navigate to the **Segments** tab.
1415
3. Click **Add new Segment**.
15-
* Give the segment a name. For example: **Morning People**.
16-
* And a description such as **For people who like to visit us in the morning**.
17-
* Set the segment type to **Core** as we don't wish this to be temporary and tied to end date for a campaign.
18-
* Select the **Time of day** parameter and configure it to **Include** times from **00:00** to **12:00** as it is a 24 hour clock.
16+
* Give the segment a name. For example: _Morning People_.
17+
* And a description such as _For people who like to visit us in the morning_.
18+
* Set the segment type to **Core** as this is not temporary and is tied to an end date for a campaign.
19+
* Select the **Time of day** parameter and configure it to **Include** times from **00:00** to **12:00** as it is a 24-hour clock.
1920

20-
For more information, see the [Personalization](../personalization/README.md) documentation.
21+
For more information, see the [Personalization](../personalization/) documentation.
2122

2223
![]()
2324

@@ -27,28 +28,24 @@ For more information, see the [Personalization](../personalization/README.md) do
2728
2. Click **Create a New Document Type**.
2829
3. Enable **Allow Segmentation** under **Permissions**.
2930
4. Save the Document Type.
30-
5. Add a new property, such as **Header**, using a **Textstring** property editor.
31-
32-
* Ensure **Allow Segmentation** is enabled for this property.
33-
34-
6. Create a piece of content using this new Document Type so we can query and request it using the Umbraco Content Delivery API
35-
36-
* _For this example lets create this piece of content at the root_
31+
5. Add a new property, such as a **Header**, using a **Textstring** property editor.
32+
* Ensure **Allow Segmentation** is enabled for this property.
33+
6. Create a piece of content using this new Document Type to query and request it using the Umbraco Content Delivery API
34+
* For this example, create this piece of content at the root.
3735

3836
### Creating Personalized Content
3937

4038
1. Open the created content and go to **Personalization**.
4139
2. Click **Add personalized variant**.
4240
3. Set the following in the **Add a new variant** dialog:
43-
44-
* Choose the segment **Morning People** we added earlier.
45-
* Give it a name and a meaningful description such as **Home Page for Morning People**.
41+
* Choose the segment **Morning People** we added earlier.
42+
* Give it a name and a meaningful description such as **Home Page for Morning People**.
4643

4744
![]()
4845

49-
4. After adding the variant we will return to the content node in split view mode
50-
5. We can then add a different piece of content we want to return in our Header property specific to morning people such as **Hello you early risers**
51-
6. Save and publish the node with the variant content
46+
4. After adding the variant we will return to the content node in split view mode.
47+
5. We can then add a different piece of content we want to return in our Header property specific to morning people such as _Hello you early risers._
48+
6. Save and publish the node with the variant content.
5249

5350
![]()
5451

@@ -59,19 +56,16 @@ Let us use the Swagger development tool to make requests to the Umbraco Content
5956
1. Navigate to the swagger endpoint of your site **/umbraco/swagger**.
6057
2. Select **Umbraco Delivery API** from the dropdown.
6158
3. Expand `/umbraco/delivery/api/v1/content/item/{path}`:
62-
63-
* Click **Try it out**.
64-
* For the path parameter, enter `/` for the example piece of content we created at the root of our site - alternatively specify the correct URL path to the content
65-
* Set the **Api-Key** parameter if your Umbraco application requires [Public Access](https://docs.umbraco.com/umbraco-cms/reference/content-delivery-api#additional-configuration) this can be toggled with the configuration value `Umbraco:CMS:DeliveryAPI:PublicAccess`
66-
67-
4. You should see the JSON result of the content node, including the default header value.
59+
* Click **Try it out**.
60+
* For the path parameter, enter `/` for the example piece of content we created at the root of our site - alternatively specify the correct URL path to the content. 
61+
* Set the **Api-Key** parameter if your Umbraco application requires [Public Access](https://docs.umbraco.com/umbraco-cms/reference/content-delivery-api#additional-configuration) this can be toggled with the configuration value `Umbraco:CMS:DeliveryAPI:PublicAccess`
62+
4. You should view the JSON result of the content node, including the default header value.
6863
5. Navigate to **uMarketingSuite Marketing API** from the definitions dropdown.
69-
* Expand `/umbraco/umarketingsuite/api/v1/analytics/pageview/trackpageview/client`:
70-
71-
* Click **Try it out**.
72-
* Modify the JSON body, setting the URL to the page visited earlier. With the content delivery api above, leave the other property **referrerUrl** empty.
73-
* Repeat the earlier steps to fetch the content by it's path. The JSON of the content node and the header property now contains our personalized content **Hello you early risers**
74-
* Remember it will only show different content if we view the page before midday.
64+
6. Expand `/umbraco/umarketingsuite/api/v1/analytics/pageview/trackpageview/client`:
65+
* Click **Try it out**.
66+
* Modify the JSON body, setting the URL to the page visited earlier. With the content delivery api above, leave the other property **referrerUrl** empty.
67+
* Repeat the earlier steps to fetch the content by it's path. The JSON of the content node and the header property now contains our personalized content **Hello you early risers**
68+
* Remember it will only show different content if we view the page before midday.
7569

7670
![]()
7771

13/umbraco-ums/marketers-and-editors/personalization/creating-a-segment.md

Lines changed: 6 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -25,9 +25,8 @@ To create a new segment, follow these steps:
2525

2626
3. Give the new segment a **Name** and a short **Description**.
2727
4. Select a segment type:
28-
29-
* **Core segments** are the fundamental building blocks of your personalization strategy
30-
* **Temporary segments** are segments **with an end date**. If some sort of campaign is running and you want to overrule existing segments you can create a temporary segment. For doing this you need to specify an end date
28+
* **Core segments** are the fundamental building blocks of your personalization strategy
29+
* **Temporary segments** are segments **with an end date**. If some sort of campaign is running and you want to overrule existing segments you can create a temporary segment. For doing this you need to specify an end date
3130

3231
### Segment Parameters
3332

@@ -52,17 +51,17 @@ By clicking on the tile you will setup a parameter for the segment. For example,
5251

5352
![]()
5453

55-
You see all browsers that have visited the website. So if you're missing a specific browser, that is because a visitor to your site has yet to use that browser.
54+
You will see all browsers that have visited the website. So if you're missing a specific browser, that is because a visitor to your site has yet to use that browser.
5655

57-
You can save the parameter and the segment will show the parameter that is part of this segment.
56+
3. Save the parameter and the segment will show the parameter that is part of this segment.
5857

5958
![]()
6059

61-
3. Add a parameter for **Time of day** to select all visitors after "**15:00**". Enter **15:00** in **From** and leave **Until** empty.
60+
4. Add a parameter for **Time of day** to select all visitors after "**15:00**". Enter **15:00** in **From** and leave **Until** empty.
6261

6362
![]()
6463

65-
Now we can save this parameter and add the segment.
64+
5. Save this parameter and add the segment.
6665

6766
We have now created a first segment and you will find that segment in the overview of your segments:
6867

Lines changed: 35 additions & 35 deletions
Original file line numberDiff line numberDiff line change
@@ -1,10 +1,10 @@
11
---
22
description: >-
3-
Discover how to analyze visitor profiles, including insights on engagement metrics,
4-
potential, personas, and detailed activity tracking.
3+
Discover how to analyze visitor profiles, including insights on engagement
4+
metrics, potential, personas, and detailed activity tracking.
55
---
66

7-
# Profile Detail
7+
# Profile detail
88

99
In the Profiles section, you can access specific visitor profiles, which contain two sections: **Insights** and **Activity**.
1010

@@ -16,12 +16,12 @@ The insights section provides an overview of the visitor.
1616

1717
Here, you can see:
1818

19-
- The date of the visitor's first session on the website,
20-
- The date of the visitor's last activity,
21-
- The number of sessions,
22-
- The number of pageviews,
23-
- The time spent on the website, and
24-
- The total engaged time.
19+
* The date of the visitor's first session on the website,
20+
* The date of the visitor's last activity,
21+
* The number of sessions,
22+
* The number of pageviews,
23+
* The time spent on the website, and
24+
* The total engaged time.
2525

2626
You can also view any goals triggered by this visitor.
2727

@@ -35,11 +35,11 @@ By default, a profile is considered active if the profile has visited the websit
3535

3636
By default, a profile is considered engaged when the engagement time of the visitor was higher than 300 seconds in the last 3 sessions.
3737

38-
The exact settings (30 days, 300 seconds, 3 sessions) can be overwritten via the [uMarketingSuite configuration file](/installing-umarketingsuite/configuration-options-1-x/).
38+
The exact settings (30 days, 300 seconds, 3 sessions) can be overwritten via the [uMarketingSuite configuration file](../../../../installing-umarketingsuite/configuration-options-1-x/).
3939

4040
## Calculated Persona & Customer Journey Phase
4141

42-
Within the profile, you can see all [personas](/personalization/implicit-explicit-personalization/setting-up-personas/) and [customer journeys](/personalization/implicit-explicit-personalization/setting-up-the-customer-journey/) that you have setup within the uMarketingSuite. Each persona and customer journey phase displays a score. You can see if uMarketingSuite has assigned a persona or journey phase to this visitor. In the below example, you see that the uMarketingSuite has assigned the persona "Data & Privacy officer" to this visitor.
42+
Within the profile, you can see all [personas](../../../../personalization/implicit-explicit-personalization/setting-up-personas/) and [customer journeys](../../../../personalization/implicit-explicit-personalization/setting-up-the-customer-journey/) that you have set up within the uMarketingSuite. Each persona and customer journey phase displays a score. You can see if uMarketingSuite has assigned a persona or journey phase to this visitor. In the below example, you see that the uMarketingSuite has assigned the persona "Data & Privacy officer" to this visitor.
4343

4444
![]()
4545

@@ -53,41 +53,41 @@ In the Activity tab, you can view all the activity of this visitor.
5353

5454
For each session, you can see:
5555

56-
- An icon indicating whether the uMarketingSuite enriched the visitor's experience (blue icon for A/B Test variant or personalized variant; grey icon if not).
57-
- The timestamp when the session was recorded.
58-
- Which device type was uesed.
59-
- The number of pages that where visited in this session.
60-
- The duration of the session.
61-
- How long the person was engaged.
62-
- The number of goals that was triggered.
63-
- The events that were triggered.
64-
- On which page the session started.
65-
- From which website the visitor came into your website.
56+
* An icon indicating whether the uMarketingSuite enriched the visitor's experience (blue icon for A/B Test variant or personalized variant; grey icon if not).
57+
* The timestamp when the session was recorded.
58+
* Which device type was used.
59+
* The number of pages that were visited in this session.
60+
* The duration of the session.
61+
* How long the person was engaged.
62+
* The number of goals that were triggered.
63+
* The events that were triggered.
64+
* On which page the session started.
65+
* From which website the visitor came into your website.
6666

6767
By clicking on a row, you can access more detailed information about that session.
6868

6969
![]()
7070

7171
You will see:
7272

73-
- The visited page.
74-
- The time of visit.
75-
- The time on page.
76-
- The engaged time on page.
77-
- The scroll depth on that page.
78-
- The number of goals that where triggered.
79-
- The number of recorded events.
80-
- The variant of the page displayed to the visitor.
81-
- The operating system, browser, and (anonymized) IP address used.
82-
- An icon indicating whether the visitor saw a personalized or A/B tested variant of the page.
73+
* The visited page.
74+
* The time of visit.
75+
* The time on page.
76+
* The engaged time on page.
77+
* The scroll depth on that page.
78+
* The number of goals that were triggered.
79+
* The number of recorded events.
80+
* The variant of the page displayed to the visitor.
81+
* The operating system, browser, and (anonymized) IP address used.
82+
* An icon indicating whether the visitor saw a personalized or A/B tested variant of the page.
8383

8484
Finally, you can drill down into the activity on a specific page:
8585

8686
![]()
8787

8888
Here, you can see:
8989

90-
- When the visitor started their visit on the page.
91-
- When the maximum scroll depth was reached.
92-
- When the visit ended.
93-
- When goals were triggered.
90+
* When the visitor started their visit on the page.
91+
* When the maximum scroll depth was reached.
92+
* When the visit ended.
93+
* When goals were triggered.

13/umbraco-ums/security-and-privacy/gdpr/README.md

Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -2,17 +2,17 @@
22

33
**Disclaimer**: Always check you are GDPR compliant with your own privacy office or legal department
44

5-
The uMarketingSuite cares about privacy and values insights. We have turned this in a standard for you and your customer. Server-side analytics in combination with a 1st party cookie was never this easy to setup. And even better; **you own your data**. uMarketingSuite is granted the [Privacy Verified certificate](../../../../%7BlocalLink:umb:/media/b03954cbbf52461897be2cb509b6b690%7D/).
5+
The uMarketingSuite cares about privacy and values insights. We have turned this into a standard for you and your customer. Server-side analytics in combination with a 1st party cookie was never this easy to set up. And even better; **you own your data**. uMarketingSuite is granted the [Privacy Verified certificate](../../../../%7BlocalLink:umb:/media/b03954cbbf52461897be2cb509b6b690%7D/).
66

7-
**You can be GDPR compliant out-of-the-box!**
7+
**You can be GDPR compliant out of the box.**
88

99
## Privacy Verified Certificate
1010

1111
[![]()](../../../../%7BlocalLink:umb:/media/b03954cbbf52461897be2cb509b6b690%7D/)You can [view our Privacy Verified Certificate](../../../../%7BlocalLink:umb:/media/b03954cbbf52461897be2cb509b6b690%7D/) which states the following:
1212

1313
* uMarketingSolutions uses specific retention periods and personal data is not kept longer than necessary.
1414
* uMarketingSolutions has set up its software according to the principles of privacy by design and by default.
15-
* uMarketingSolutions correctly informs customers, by means of a white paper, of the obligation to inform about the use of uMarketingSuite.
15+
* uMarketingSolutions correctly informs customers, using a white paper, of the obligation to inform about the use of uMarketingSuite.
1616
* uMarketingSolutions informs its customers correctly, by means of a white paper, that permission is required for placing and reading the cookie from uMarketingSuite
1717

1818
## GDPR Whitepaper
@@ -28,7 +28,7 @@ uMarketingSuite has been designed with the principles of privacy by design and p
2828
(except for, for example, your own hosting provider), as the cookie is first\
2929
party.
3030

31-
You have the possibility to change default settings. However, we do not recommend doing so, as they are set in line with the General Data Protection Regulation (hereinafter: GDPR).
31+
You can change the default settings. However, we do not recommend doing so, as they are set in line with the General Data Protection Regulation (hereinafter: GDPR).
3232

3333
### Information obligation
3434

@@ -38,8 +38,8 @@ When using uMarketingSuite, this means that you, as a customer, have to inform a
3838
3939
### Cookie consent 🍪
4040

41-
[The cookie of uMarketingSuite can be categorized as an analytical and personalization cookie in one](../../../../the-umarketingsuite-broad-overview/the-umarketingsuite-cookie/), as the cookie is used to analyse website visitor behaviour and to personalize the content of the website based on this behaviour. For analytical and personalization cookies consent is required, based on the GDPR and the ePrivacy Directive.
41+
[The cookie of uMarketingSuite can be categorized as an analytical and personalization cookie in one](../../../../the-umarketingsuite-broad-overview/the-umarketingsuite-cookie/), as the cookie is used to analyze website visitor behavior and to personalize the content of the website based on this behavior. For analytical and personalization cookies consent is required, based on the GDPR and the ePrivacy Directive.
4242

4343
As a customer and the controller of the personal data processed by the use of uMarketingSuite, **it is your responsibility to obtain consent from the website visitor for the use of the uMarketingSuite cookie**. Consent can be obtained by means of a cookie banner.
4444

45-
Following the GDPR whitepaper in combination with cookie consent, you [can control the features of uMarketingSuite and give your visitors total control over which features they wish to enable](../../../../the-umarketingsuite-broad-overview/the-umarketingsuite-cookie/module-permissions/), Analytics, A/B Testing or Personalizatio
45+
Following the GDPR whitepaper in combination with cookie consent, you [can control the features of uMarketingSuite and give your visitors total control over which features they wish to enable](../../../../the-umarketingsuite-broad-overview/the-umarketingsuite-cookie/module-permissions/), Analytics, A/B Testing, or Personalization.

0 commit comments

Comments
 (0)