Skip to content

Commit d5d9dae

Browse files
authored
Merge pull request #457 from segmentio/repo-sync
repo sync
2 parents 7654958 + 6980934 commit d5d9dae

File tree

12 files changed

+146
-130
lines changed

12 files changed

+146
-130
lines changed

src/_data/sidenav/engage.yml

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -85,10 +85,10 @@ sections:
8585
section:
8686
- path: '/engage/analytics'
8787
title: Analytics Overview
88-
- path: '/engage/analytics/message-events'
89-
title: Message Events
90-
# - path: '/engage/analytics/custom-events'
91-
# title: Custom Events
88+
# - path: '/engage/analytics/message-events'
89+
# title: Message Events
90+
# - path: '/engage/analytics/custom-events'
91+
# title: Custom Events
9292
# - section_title: Settings
9393
# section:
9494
# - path: '/engage/settings/messaging-settings'
@@ -112,4 +112,4 @@ sections:
112112
# - path: '/engage/settings/labels'
113113
# title: Labels
114114
path: '/engage/contact'
115-
title: Support
115+
title: Support

src/_includes/content/destination-dossier.html

Lines changed: 6 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -43,7 +43,12 @@
4343
<h6>Destination Info</h6>
4444
<ul class="qi">
4545
{% if destMethods.size > 0 %}<li>Accepts {% for method in destMethods%}{% if destMethods.size == 1 %}{{method}} calls.{% else %}{% unless forloop.last == true %}{{method}}, {% endunless %}{% if forloop.last == true%}and {{method}} calls{%endif%}{% endif %}{% endfor %}</li>{% endif %}
46-
<li>Referred to as <strong>{{previous_names | join: '</strong>, or <strong>' }}</strong> in the <a href="/docs/guides/filtering-data/#filtering-with-the-integrations-object">Integrations object</a></li>
46+
{% if previous_names.size == 1 or components.size == 0 %}
47+
<li>Refer to it as <strong>{{previous_names | join: '</strong>, or <strong>' }}</strong> in the <a href="/docs/guides/filtering-data/#filtering-with-the-integrations-object">Integrations object</a></li>
48+
{% else %}
49+
{% if connectionModes.cloud.web == true or connectionModes.cloud.mobile == true or connectionModes.cloud.server == true %} <li>In Cloud-mode, refer to it as <strong>{{previous_names | join: '</strong>, or <strong>' }}</strong> in the <a href="/docs/guides/filtering-data/#filtering-with-the-integrations-object">Integrations object</a></li>{%endif%}
50+
{% if connectionModes.device.web == true or connectionModes.device.mobile == true or connectionModes.device.server == true %} <li>In Device-mode, refer to it as <strong>{{previous_names | first}}</strong> in the <a href="/docs/guides/filtering-data/#filtering-with-the-integrations-object">Integrations object</a> </li>{%endif%}
51+
{% endif %}
4752
{% if destinationInfo.status == "PUBLIC_BETA" %}<li>This destination is in <span class="release-pill">Beta</span></li>{% endif %}
4853
</ul>
4954
{% if components.size > 0%}

src/_includes/content/destination-footer.md

Lines changed: 0 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -46,19 +46,7 @@ Segment lets you change these destination settings from the Segment app without
4646
{% endunless %}
4747
{% if currentIntegration.previous_names.size > 1 %}
4848

49-
{% unless page.hide-integrations-object == true %}
50-
## Adding {{ currentIntegration.display_name }} to the integrations object
5149

52-
To add {{ currentIntegration.display_name }} to the `integrations` JSON object (for example, [to filter data from a specific source](/docs/guides/filtering-data/#filtering-with-the-integrations-object)), use one of the following valid names for this integration:
53-
{% if page.name-override %}
54-
{% assign currentIntegration = site.data.catalog.overrides.items | where: "slug", currentSlug | first %}
55-
{% endif %}
56-
57-
{% for valid_name in currentIntegration.previous_names %}
58-
- {{ valid_name }}
59-
{% endfor %}
60-
61-
{% endunless %}
6250
{% endif %}
6351

6452
{% endif %}

src/connections/destinations/catalog/algolia-insights/index.md

Lines changed: 0 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,6 @@
11
---
22
title: Algolia Insights Destination
33
rewrite: true
4-
layout: dest-test
54
beta: true
65
redirect_from: '/connections/destinations/catalog/algolia/'
76
id: 5d373a350abf930001a6b70f

src/connections/destinations/catalog/variance/index.md

Lines changed: 10 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -85,6 +85,16 @@ analytics.group("groupId123", {
8585

8686
Segment sends Group calls to Variance as an `Account` if you've chosen the "Group" Account Mapping method during setup.
8787

88+
### Alias
89+
90+
If you're not familiar with the Segment Spec, take a look at the [Alias method documentation](/docs/connections/spec/alias/) to learn about what it does. An example call would look like this:
91+
92+
```js
93+
analytics.alias('123456')
94+
```
95+
96+
If there is an existing user with that `userId` in Variance that matches the `previousId` passed with the alias, that user will be merged into the "123456" user identified in the alias. If there is only one user with the `previousId` and no user with the `userId`, that user will have their Variance `externalId` updated to match the current `userId` passed in the alias.
97+
8898
## Account Mapping
8999

90100
Variance offers several ways to map your users to accounts or companies, including the following.

src/connections/spec/ecommerce-tracking-plan.md

Lines changed: 0 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -189,6 +189,4 @@ Aside from funnel health, having these key pieces of customer data gives compani
189189

190190
Without taking this critical step of mapping out key customer events, businesses often spend too much time revisiting their data model or analyzing impartial data sets. Instead they could spend that time understanding and addressing customers' needs.
191191

192-
_Want to get started immediately?_ [Download the e-commerce tracking plan template](https://docs.google.com/spreadsheets/d/1TA6qTcDHoZzsG7-C6p5yHGximDxqoNtizguKs7Z0av4/view).
193-
194192
[Talk to a product specialist today](https://segment.com/contact/sales) _about building a clean, high-quality data spec so you can focus on brand engagement and sales growth._

src/engage/analytics/index.md

Lines changed: 55 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -2,4 +2,58 @@
22
title: Analytics Overview
33
layout: engage
44
engage: true
5-
---
5+
---
6+
7+
Twilio Engage provides you with analytics that give you insight into the performance of your [email and SMS campaigns](/docs/engage/campaigns/).
8+
9+
On this page, you'll learn how Engage calculates campaign analytics and which specific messaging events you can view.
10+
11+
## How Engage measures campaign analytics
12+
13+
Understanding when and how Engage measures campaign analytics will help you as you review your analytics reports.
14+
15+
Engage begins tracking campaign performance after you send a campaign. As a result, a campaign's analytics only reflect conversions that occurred after campaign publication. For example, suppose you send an email campaign promoting a sale in your online store. If a customer purchases a qualifying product **before** receiving your campaign, their purchase would not count as a conversion.
16+
17+
Campaign engagement metrics are based only on delivered campaigns. Suppose, for example, you send an email campaign to 20 email addresses but only 10 successfully deliver. Engagement metrics like opens, clicks, and conversions would display as a percentage of the 10 delivered campaigns. In this case, then, if five users opened your campaign, you'd see a 50% total opened rate in the campaign's analytics.
18+
19+
## Access a campaign's analytics
20+
21+
You'll find a campaign's analytics within its parent Journey, using the following instructions:
22+
23+
1. Within your Personas space, select the **Journeys** tab.
24+
2. From the Journeys table, select the Journey you want to view.
25+
3. From the Journey overview, select the email or SMS campaign you want to view.
26+
4. A modal pane appears that displays your campaign's analytics.
27+
28+
## Email messaging events
29+
30+
The following table lists the email campaign events that Engage tracks:
31+
32+
| Event | Description |
33+
| -------------- | ------------------------------------------------------------------------------------------- |
34+
| Sent | The number of emails campaigns that you sent. |
35+
| Delivered | The number of emails campaigns that were accepted by the receiving inbox server. |
36+
| Bounced | The number of email campaigns that bounced instead of being delivered. |
37+
| Total Opened | The number of times that your email campaigns were opened. |
38+
| Total Clicked | The number of times that recipients clicked within your email campaigns. |
39+
| Unique Opened | The number of unique recipients that opened your email campaigns. |
40+
| Unique Clicked | The number of unique recipients that clicked your email campaign. |
41+
| Unsubscribed | The number of campaign recipients who chose to unsubscribe from within the email campaigns. |
42+
| Spam Reported | The number of recipients who marked your email as spam. |
43+
| Converted To | The number of conversions that took place after campaign publication. |
44+
45+
SendGrid powers Engage's email campaign event analytics. For more details on email events, view SendGrid's [Marketing Campaigns Statistics Overview](https://docs.sendgrid.com/ui/analytics-and-reporting/marketing-campaigns-stats-overview){:target="_blank"}.
46+
47+
48+
## SMS messaging events
49+
50+
The following table lists the SMS campaign events that Engage tracks:
51+
52+
53+
| Event | Description |
54+
| ----------- | --------------------------------------------------------------------- |
55+
| Sent | The number of SMS campaigns that you sent. |
56+
| Delivered | The number of SMS campaigns that were accepted by the user's carrier. |
57+
| Queued | The number of SMS campaigns queued for delivery, but not yet sent. |
58+
| Undelivered | The number of undelivered SMS campaigns. |
59+
| Failed | The number of SMS campaigns that didn't send. |

src/engage/analytics/message-events.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -2,4 +2,4 @@
22
title: Message Events
33
layout: engage
44
engage: true
5-
---
5+
---

src/getting-started/03-planning-full-install.md

Lines changed: 7 additions & 30 deletions
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,7 @@
22
title: Planning a Full Installation
33
---
44

5-
Now that we've shown you Segment in action, let's step back and think through what a full implementation of Segment for your organization would look like. We know that figuring out what events to track in Segment can feel overwhelming. You should expect this planning process to have the following steps:
5+
Now that you've seen Segment in action, step back and think through what a full implementation of Segment for your organization would look like. Figuring out what events to track in Segment can feel overwhelming. You should expect this planning process to have the following steps:
66

77
<!-- TOC depthFrom:1 depthTo:2 withLinks:1 updateOnSave:1 orderedList:0 -->
88

@@ -36,7 +36,7 @@ Tracking is about learning and taking action. Think about what you want to know
3636
- How do people discover, start using, and paying for your product?
3737
- What are the most important steps in a customer's journey?
3838

39-
While it may seem obvious, we highly recommend documenting your high-level business objectives (see [the Goals tab in Google Sheet Tracking Plan](https://docs.google.com/spreadsheets/d/1TA6qTcDHoZzsG7-C6p5yHGximDxqoNtizguKs7Z0av4/view) template). More specifically, ask yourself: what are the measurable business outcomes you want to achieve this year? Do you want to acquire new customers? Generate more new sign-ups, drive more incremental revenue among your current customer base?
39+
While it may seem obvious, we highly recommend documenting your high-level business objectives. More specifically, ask yourself: what are the measurable business outcomes you want to achieve this year? Do you want to acquire new customers? Generate more new sign-ups, drive more incremental revenue among your current customer base?
4040

4141
The best way to answer this question is to interview stakeholders in your organization who will consume the data.
4242

@@ -60,8 +60,6 @@ With your business objectives documented and mapped to user actions, it's time t
6060

6161
When you're first starting out, we recommend that you limit your tracking plan to a few core events, but add lots of properties to provide context about them. We generally see more success with the “less is more” philosophy of tracking data, but you might also decide to take a more liberal “track more and analyze later” approach. Like everything, each alternative has pros and cons that are important to consider especially as it relates to your company's needs.
6262

63-
If you're having trouble starting out, we recommend that you look at our free [Tracking Plan spreadsheet template](https://docs.google.com/spreadsheets/d/1TA6qTcDHoZzsG7-C6p5yHGximDxqoNtizguKs7Z0av4/view) for inspiration. (We'll talk more about Tracking Plans [below](#develop-a-tracking-plan).)
64-
6563
### Shortcut! Check if a Business Spec meets your needs
6664

6765
Segment maintains several "Business Specs", which are recommendations based on your type of business that give recommendations on what to track, what additional traits or properties to collect, and how to format them. The two most common are the B2B (business-to-business) Spec, Ecommerce Spec, and our Mobile and Video specs.
@@ -100,40 +98,19 @@ Regardless of approach, here are some important best practices to keep in mind:
10098

10199
- **Don't create property keys dynamically:** Avoid creating property names like `"feature_1":"true"`,`"feature_2":"false"` as these are ambiguous and very difficult to analyze
102100

103-
![](/docs/protocols/images/asset_nVdJ3ZyA.png)
101+
![An image comparing good and bad naming and collection standards](/docs/protocols/images/asset_nVdJ3ZyA.png)
104102

105103

106104
Got all that? Great! You're now ready to develop a Tracking Plan.
107105

108106
<!--Source: /docs/protocols/data-quality/whats-a-tracking-plan/ or /docs/protocols/tracking-plan/ -->
109107

110-
## Develop a Tracking Plan
108+
## Develop a tracking plan
111109

112-
A [tracking plan](https://segment.com/blog/what-is-a-tracking-plan/) clarifies what events to track, where those events live in the code base, and why you're tracking those events (from a business perspective). **A good tracking plan represents the single source of truth about what data you collect, and why.**
110+
A [tracking plan](https://segment.com/blog/what-is-a-tracking-plan/){:target="_blank"} clarifies what events to track, where those events live in the code base, and why you're tracking those events (from a business perspective). **A good tracking plan represents the single source of truth about what data you collect, and why.**
113111

114112
Your tracking plan is probably maintained in a spreadsheet (unless you use our tracking-plan tool, [Protocols](/docs/protocols/)), and serves as a project management tool to get your organization in agreement about what data to use to make decisions. A tracking plan helps build a shared understanding of the data among marketers, product managers, engineers, analysts, and any other data users.
115113

116-
In the next section, we share how to build a tracking plan from the ground up using a Google Sheet template. Note that you can use any tool to create the tracking plan!
117-
118-
### Using the Tracking Plan Google Sheets template
119-
120-
To help you get started, we developed a Tracking Plan template in [Google Sheets](https://docs.google.com/spreadsheets/d/1TA6qTcDHoZzsG7-C6p5yHGximDxqoNtizguKs7Z0av4/view).
121-
122-
The template includes all of our Business-case ("semantic") Specs (which we mentioned [above](#shortcut-check-if-a-business-spec-meets-your-needs)) as tabs, including [eCommerce](/docs/connections/spec/ecommerce/v2/), [B2B SaaS](/docs/connections/spec/mobile/), [Mobile](/docs/connections/spec/mobile/) and [Video](/docs/connections/spec/video/), and a collection of common properties.
123-
124-
![](images/trackingplans.png)
125-
126-
With your business goals defined, start by defining how you want to track Page/Screen, Identify and Group events. Most customers use [default page tracking](/docs/connections/sources/catalog/libraries/website/javascript/#page) and skip over that tab.
127-
128-
The Identify tab is where you specify which user traits you intend to collect like `first_name`, `last_name`, `email`, etc. Read more about the [identify call below](/docs/protocols/tracking-plan/best-practices/#identify-your-users).
129-
130-
From there, we recommend you specify Track events in the **Track (Custom)** tab. The template includes preexisting events with different numbers of grouped properties (1 Prop Event, 2 Prop Event, etc). While this might be more challenging to work with at first, this structure allows you to use the **Minimize Rows** button at the top to organize and view all events.
131-
132-
Once you complete the tracking plan, you can share the Google Sheet with stakeholders to review, comment, and edit, or simply to share as a reference for implementation.
133-
134-
> success ""
135-
> **Tip**! If you decide to purchase [Protocols](/docs/protocols/) in the future, you'll be able to upload the tracking plan into Segment [using the Config API](/docs/protocols/apis-and-extensions/#google-sheets-tracking-plan-uploader).
136-
137114
### Plan your Identify and Group calls
138115

139116
The Identify call updates all records of the user with a set of traits, and so is extremely important for building your understanding of your users. But how do you choose which traits to include?
@@ -188,7 +165,7 @@ An online community, on the other hand, has an entirely different set of actions
188165
- **Content Produced**
189166
- **Content Curated**
190167

191-
With these actions tracked, the community can develop metrics around engagement, and understand how users move towards their ultimate conversion events. You can read more in [this article from the online community GrowthHackers](https://segment.com/blog/growthhackers-community-metrics/) about the events they track and why.
168+
With these actions tracked, the community can develop metrics around engagement, and understand how users move towards their ultimate conversion events. You can read more in [this article from the online community GrowthHackers](https://segment.com/blog/growthhackers-community-metrics/){:target="_blank"} about the events they track and why.
192169

193170
### Define your Track event properties
194171

@@ -234,7 +211,7 @@ Once you have an initial list of the destination tools your organization uses, y
234211
Additionally, you should check [which connection modes each tool supports](/docs/connections/destinations/cmodes-compare/), so you know ahead of time which destinations may need to be bundled.
235212

236213
> success ""
237-
> **Tip**: If you know you're looking for a tool for a specific purpose, but haven't chosen one yet, you can also check the [Connection Modes by category page](https://segment.com/docs/connections/destinations/category-compare/) to see which tools might be compatible with the least implementation changes.
214+
> **Tip**: If you know you're looking for a tool for a specific purpose, but haven't chosen one yet, you can also check the [Connection Modes by category page](https://segment.com/docs/connections/destinations/category-compare/){:target="_blank"} to see which tools might be compatible with the least implementation changes.
238215
239216

240217

src/getting-started/implementation-guide.md

Lines changed: 1 addition & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -146,10 +146,8 @@ Segment maintains a number of industry or product-specific specs to help you get
146146
- [Video](/docs/connections/spec/video/)
147147
- [Mobile](/docs/connections/spec/mobile/)
148148

149-
Once you're ready to define the events you'd like to track, you can use [this Tracking Plan Template](https://docs.google.com/spreadsheets/d/1TA6qTcDHoZzsG7-C6p5yHGximDxqoNtizguKs7Z0av4/view#gid=1164785081) to help you align your team.
150-
151149
> info "Learn More"
152-
> - [Data Collection Best Practices](/docs/protocols/tracking-plan/best-practices/#tracking-plan-google-sheets-template)
150+
> - [Data Collection Best Practices](/docs/protocols/tracking-plan/best-practices/)
153151
> - [Analytics Academy: How to create a successful data tracking plan](https://segment.com/academy/collecting-data/how-to-create-a-tracking-plan/){:target="_blank"}
154152
> - [Segment University: Planning your implementation](https://university.segment.com/data-governance-tracking-plans-the-source-of-truth){:target="_blank"}
155153

0 commit comments

Comments
 (0)