Skip to content

Commit 6a975ec

Browse files
stayseesongstayseesong
authored
Merge pull request #6004 from ozzy-cox/develop
Updated userguiding source documentation details
2 parents ccaf648 + 7ecfe5d commit 6a975ec

File tree

1 file changed

+60
-58
lines changed
  • src/connections/sources/catalog/cloud-apps/userguiding

1 file changed

+60
-58
lines changed

‎src/connections/sources/catalog/cloud-apps/userguiding/index.md

Lines changed: 60 additions & 58 deletions
Original file line numberDiff line numberDiff line change
@@ -13,8 +13,8 @@ This source is maintained by UserGuiding. For any issues with the source, [conta
1313
## Getting started
1414

1515
1. From your workspace's [Sources catalog page](https://app.segment.com/goto-my-workspace/sources/catalog){:target="_blank”} click **Add Source**.
16-
2. Search for "UserGuiding" in the Sources Catalog, select UserGuiding, and click **Add Source**.
17-
3. On the next screen, give the Source a name configure any other settings.
16+
2. Search for *UserGuiding* in the Sources Catalog, select UserGuiding, and click **Add Source**.
17+
3. Give the Source a name configure any other settings.
1818

1919
- The name is used as a label in the Segment app, and Segment creates a related schema name in your warehouse. The name can be anything, but we recommend using something that reflects the source itself and distinguishes amongst your environments (eg. UserGuiding_Prod, UserGuiding_Staging, UserGuiding_Dev).
2020

@@ -32,61 +32,63 @@ UserGuiding sends user identifiers in the `user_id` attribute in the event paylo
3232

3333
The table below lists events that UserGuiding sends to Segment. These events appear as tables in your warehouse, and as regular events in other Destinations. UserGuiding includes the `userId` if available.
3434

35-
| UserGuiding Event Name | Description |
36-
| ------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------ | |
37-
| Guide started | It means that a user previews the first step of a Guide |
38-
| Guide completed | It means that the user has completed all steps of a Guide |
39-
| Hotspot interacted | It means that the user interacted with a Hotspot group and saw a Hotspot as content. (remember, Hotspot groups can have multiple Hotspots as contents) |
40-
| Checklist item trigger | It means that the user triggers a Checklist Guide |
41-
| Checklist item url click | It means that the user clicks a URL item on a Checklist |
42-
| Checklist completed | It means that the user completed a Checklist |
43-
| Resource center guide trigger | It means that the user triggered a Resource Center Guide |
44-
| Resource center checklist guide trigger | It means that a Guide in a Checklist put in a Resource Center as a module is triggered by a user |
45-
| Resource center checklist item url click | It means that a URL item in a Checklist put in a Resource Center as a module is clicked by a user |
46-
| Resource center external URL click | It means that a user clicks an external URL in a Resource Center |
47-
| Resource center article link click | It means that a user clicks a search article in a Resource Center |
48-
| Resource center survey trigger | It means that a user has triggered a survey in a Resource Center |
49-
| Survey shown | It means a survey was shown to a user |
50-
| Survey question answer | It means a survey question was answered by a user |
51-
52-
53-
## Event Properties
54-
55-
The table below list the properties included in the events listed above.
56-
57-
| Property Name | Description | Type |
58-
| -------------------- | ------------------------- | ---- |
59-
| `user_id` | User identifier | str |
60-
| `guideId` | Email event type | int |
61-
| `guideName` | Prospect user ID | str |
62-
| `pageUrl` | ID of the email | str |
63-
| `hotspotGroupId` | Sender email ID | int |
64-
| `hotspotGroupName` | Subject line of the email | str |
65-
| `hotspotId` | Subject line of the email | int |
66-
| `hotspotTitle` | Subject line of the email | str |
67-
| `checklistName` | URL of the link clicked | str |
68-
| `checklistId` | URL of the link clicked | int |
69-
| `checklistItemUrl` | URL of the link clicked | str |
70-
| `resourceCenterName` | URL of the link clicked | str |
71-
| `resourceCenterID` | URL of the link clicked | int |
72-
| `resourceCenterId` | URL of the link clicked | int |
73-
| `externalUrl` | URL of the link clicked | str |
74-
| `articleLink` | URL of the link clicked | str |
75-
| `surveyId` | URL of the link clicked | int |
76-
| `surveyName` | URL of the link clicked | str |
77-
| `questionId` | URL of the link clicked | str |
78-
| `questionName` | URL of the link clicked | str |
79-
| `score` | URL of the link clicked | int |
80-
| `surveyQuestion` | URL of the link clicked | str |
81-
| `emojiScore` | URL of the link clicked | str |
82-
| `choices` | URL of the link clicked | str |
83-
| `feedback` | URL of the link clicked | str |
84-
85-
86-
## Adding Destinations
87-
88-
Now that your Source is set up, you can connect it to Destinations.
89-
90-
Log into your downstream tools and check to see that your events appear as expected, and that they contain all of the properties you expect. If your events and properties don’t appear, check the [Event Delivery](/docs/connections/event-delivery/) tool, and refer to the Destination docs for each tool for troubleshooting.
35+
| UserGuiding Event Name | Description |
36+
| ---------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------ |
37+
| Guide Started | It means that a user previews the first step of a Guide |
38+
| Guide Completed | It means that the user has completed all steps of a Guide |
39+
| Hotspot Interacted | It means that the user interacted with a Hotspot group and saw a Hotspot as content. (remember, Hotspot groups can have multiple Hotspots as contents) |
40+
| Checklist Item Trigger | It means that the user triggers a Checklist Guide |
41+
| Checklist Item Url Click | It means that the user clicks a URL item on a Checklist |
42+
| Checklist Completed | It means that the user completed a Checklist |
43+
| Resource Center Guide Trigger | It means that the user triggered a Resource Center Guide |
44+
| Resource Center Checklist Guide Trigger | It means that a Guide in a Checklist put in a Resource Center as a module is triggered by a user |
45+
| Resource Center Checklist Item Url Click | It means that a URL item in a Checklist put in a Resource Center as a module is clicked by a user |
46+
| Resource Center External URL Click | It means that a user clicks an external URL in a Resource Center |
47+
| Resource Center Article Link Click | It means that a user clicks a search article in a Resource Center |
48+
| Resource Center Survey Trigger | It means that a user has triggered a survey in a Resource Center |
49+
| Survey Shown | It means a survey was shown to a user |
50+
| Survey Question Answer | It means a survey question was answered by a user |
51+
52+
53+
## Event properties
54+
55+
The table below lists the properties included in the events listed above.
56+
57+
| Property Name | Description |
58+
| ---------------------- | ----------------------------------------------------------------- |
59+
| `user_id` | User identifier | str |
60+
| `guide_id` | ID of the guide | int |
61+
| `guide_name` | Name of the guide | str |
62+
| `page_url` | URL of the page the material was interacted at | str |
63+
| `hotspot_group_id` | Group ID of the hotspot | int |
64+
| `hotspot_group_name` | Group name of the hotspot | str |
65+
| `hotspot_id` | ID of the hotspot | int |
66+
| `hotspot_title` | Title of the hotspot | str |
67+
| `checklist_name` | Name of the checklist | str |
68+
| `checklist_id` | ID of the checklist | int |
69+
| `checklist_item_url` | Item URL of the checklist | str |
70+
| `resource_center_name` | Name of the resource center | str |
71+
| `resource_center_id` | ID of the resource center | int |
72+
| `external_url` | External URL of resource center url click event | str |
73+
| `article_link` | Link to the article in resource center where click event happened | str |
74+
| `survey_id` | ID of the survey | int |
75+
| `survey_name` | Name of the survey | str |
76+
| `question_id` | ID of the question in a survey | str |
77+
| `question_name` | Name of the question | str |
78+
| `score` | Score in a survey question answer | int |
79+
| `survey_question` | Question text of a survey | str |
80+
| `emoji_score` | Emoji score in a survey question answer | str |
81+
| `choices` | Choices in a survey question | str |
82+
| `feedback` | Feedback left in survey question answer | str |
83+
84+
## Adding destinations
85+
86+
Once your source is set up, you can connect it to destinations.
87+
88+
Log in to your downstream tools and check to see that your events appear as expected, and that they contain all of the properties you expect. If your events and properties don’t appear, check the [Event Delivery](/docs/connections/event-delivery/) tool, and refer to the destination docs for each tool for troubleshooting.
9189

9290
If there are any issues with how the events are arriving to Segment, [contact the UserGuiding support team](mailto:[email protected]).
91+
92+
## Regional data
93+
94+
If you want to use [Regional Segment](/docs/guides/regional-segment/) to store your data in EU regional data centers, use the radio button in the Userguiding as a Source section in Integrations Page to select the Data Residency.

0 commit comments

Comments
 (0)