Skip to content

Commit e921184

Browse files
authored
Merge pull request #2419 from segmentio/develop
Release 22.4.2
2 parents 876f05d + 07d8d8a commit e921184

File tree

10 files changed

+147
-4
lines changed

10 files changed

+147
-4
lines changed

.github/release.yml

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -5,6 +5,7 @@ changelog:
55
- autoupdate
66
- back-end
77
- release
8+
- hidden
89
authors:
910
- bot-docsteam
1011
categories:

src/_includes/components/actions-fields.html

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -28,6 +28,9 @@
2828
</tbody>
2929
</table>
3030

31+
{% else %}
32+
<em>No settings available. The destination may not be publicly visble.</em>
33+
3134

3235
{% endif %}
3336

@@ -62,8 +65,10 @@
6265

6366
</table>
6467

68+
6569
{% endif %}
6670

71+
6772
## Available Actions
6873

6974

402 KB
Loading
Lines changed: 110 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,110 @@
1+
---
2+
title: Mixpanel (Actions) Destination
3+
hide-boilerplate: true
4+
hide-dossier: true
5+
hidden: true
6+
---
7+
{% include content/plan-grid.md name="actions" %}
8+
9+
10+
[Mixpanel](https://mixpanel.com/){:target='_blank'} enables you to build better products through powerful, self-serve product analytics to help you convert, engage, and retain more users.
11+
12+
13+
## Benefits of Mixpanel (Actions) vs Mixpanel Classic
14+
15+
Mixpanel (Actions) provides the following benefits over the classic Mixpanel destination:
16+
- **Simpler setup** - Mixpanel (Actions) has a streamlined default setup process making it easier to get started in a way that "just works".
17+
- **More control** - Actions-based destinations enable you to define the mapping between the data Segment receives from your source, and the data Segment sends to the destination.
18+
- **Additional default property mappings** - More default mappings from the Segment context like app name, app namespace, device type, and more.
19+
- **Improved Groups support** - Implementation of [Segment Groups](/docs/connections/spec/group/) with [Mixpanel Group Analytics](https://help.mixpanel.com/hc/en-us/articles/360025333632-Group-Analytics){:target='_blank'} is easier. If you're already using Segment Groups, no code changes are required.
20+
21+
## Getting started
22+
23+
1. Go to your [Mixpanel project settings](https://mixpanel.com/report/settings/#account/projects){:target='_blank'}. Copy the Mixpanel API Key and API Secret for your project.
24+
2. From the Segment web app, click **Catalog**, then click **Destinations**.
25+
3. Find the Destinations Actions item in the left navigation, and click it.
26+
4. Click the "Mixpanel" item to select it and click **Configure**.
27+
5. Choose which of your sources to connect the destination to. (You can connect more sources to the destination later.)
28+
29+
### Connection Modes for Mixpanel (Actions) destination
30+
31+
The Mixpanel (Actions) destination does not offer a device-mode connection mode. If you're using one of Segment's new libraries ([Analytics.js 2.0](/docs/connections/sources/catalog/libraries/website/javascript/), [Swift](https://github.com/segmentio/analytics-swift) or [Kotlin](https://github.com/segmentio/analytics-kotlin)) with the Actions-framework version of the destination, you do not need the device-mode connection.
32+
33+
Once you have a mapping, you can follow the steps in the Destinations Actions documentation on [Customizing mappings](/docs/connections/destinations/actions/#customizing-mappings).
34+
35+
{% include components/actions-fields.html content1=group_identify_user_details section1="groupIdentifyUser" %}
36+
37+
<!-- MZ (1/25/2022): Once the destination is publicly available, this section will appear in the Group Identify User Details action section -->
38+
39+
{% comment %}
40+
capture group_identify_user_details
41+
{% endcomment %}
42+
43+
In the default configuration, Mixpanel (Actions) triggers this action when it receives a Group call.
44+
45+
> warning ""
46+
> Group Analytics is available as an add-on package to customers on [Growth](https://mixpanel.com/pricing/){:target='_blank'} and [Enterprise](https://mixpanel.com/pricing/){:target='_blank'} plans.
47+
48+
This action sets or updates the properties of specific groups. Use this when you want to update properties on a [group profile](https://help.mixpanel.com/hc/en-us/articles/360025333632-Group-Analytics#group-profiles){:target='_blank'}.
49+
50+
The Groups model in Segment is slightly different than in Mixpanel. To explain the conceptual difference, it may help to think in terms of database tables. In Segment, there is a single "groups" table. You can have as many group rows as you want and each row has a unique identifier. When you want to set traits on that group, you only need to know the group id.
51+
52+
However, in Segment you cannot distinguish between "types" of groups. For example, a user can belong to a "Company" as well as a "Team". There is no way to differentiate between those in Segment. In Mixpanel, you can have multiple group types which are defined by a `group key`. To update group traits in Mixpanel you need to specify the `group key` *and* `group id`.
53+
54+
### Default group key
55+
By default, the Mixpanel (Actions) destination uses `$group_id` as the group key. Create a new group in Mixpanel with `$group_id` as the group key to complete the configuration.
56+
57+
1. Go to your [Mixpanel project](https://mixpanel.com/report){:target='_blank'} settings
58+
2. Scroll to the "Group Keys" section. If this section doesn't exist, you may not have the Group Analytics add-on.
59+
3. Create the new group key:
60+
61+
![Set Group Key](./images/set-group-key.gif)
62+
63+
### Using a different group key
64+
If you already have a group set up in Mixpanel with a different group key and wish to use that one, you can specify it in the `Group Key` field of the destination configuration.
65+
66+
### Backwards-compatibility with Mixpanel Classic destination
67+
In the classic destination, the "group id" specified in the Segment SDK call was ignored and you were required to set a trait where the key of the trait is the group key and the value of that trait is the group id. While that is no longer necessary, this behavior is supported in the Mixpanel (Actions) destination to ensure backwards-compatibility. *If* you specify a trait that matches specified group key, we will use the value of that trait as the group id.
68+
69+
#### Scenario 1: No group key trait specified
70+
```js
71+
analytics.group("0e8c78ea9d97a7b8185e8632", {
72+
name: "Initech",
73+
industry: "Technology",
74+
employees: 329,
75+
plan: "enterprise",
76+
"total billed": 830
77+
});
78+
```
79+
The group id that Mixpanel will use is `0e8c78ea9d97a7b8185e8632`.
80+
81+
#### Scenario 2: Group key trait IS specified
82+
```js
83+
analytics.group("0e8c78ea9d97a7b8185e8632", {
84+
$group_id: "12345",
85+
name: "Initech",
86+
industry: "Technology",
87+
employees: 329,
88+
plan: "enterprise",
89+
"total billed": 830
90+
});
91+
```
92+
The group id that Mixpanel will use is `12345`.
93+
94+
{% comment %}
95+
endcapture
96+
{% endcomment %}
97+
98+
99+
## Migration from Mixpanel Classic
100+
101+
{% include content/ajs-upgrade.md %}
102+
103+
Assuming you're already using Segment Cloud-mode, the Mixpanel (Actions) destination is expected to have no breaking changes when upgrading. With the exception of a few new properties added to your events in the new Actions destination, there should be no difference in the data received in Mixpanel when using either of the Mixpanel destinations.
104+
105+
If you want to confirm, you can configure the new destination to point to a different Mixpanel project and connect it to the same source(s) as the Classic destination and manually verify before fully switching over.
106+
107+
> info ""
108+
> Contact Mixpanel support if you find features missing from the Mixpanel (Actions) destination that were available in the classic Mixpanel destination.
109+
110+
{% include components/actions-map-table.html name="mixpanel" %}

src/connections/sources/catalog/cloud-apps/facebook-lead-ads/index.md

Lines changed: 0 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -8,8 +8,6 @@ Facebook Lead Ads help you capture contact information from people who have expr
88

99
Segment lets you make the most of your leads by automatically sending them to your business tools like CRM and email. Importantly, these destinations allow you to contact customers in real-time using your communication platform of choice, whether you've promised them a demo, a newsletter, a piece of content, or a call from a salesperson.
1010

11-
This source is maintained by Facebook. For any issues with the source, contact the Facebook Support team.
12-
1311
{% include content/beta-note.md %}
1412

1513

src/connections/sources/catalog/cloud-apps/regal-voice/index.md

Lines changed: 8 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -28,6 +28,7 @@ The table below lists events that Regal Voice sends to Segment. These events app
2828
| ---------------------------- | ----------------------------------------------------------------------------------------------------- |
2929
| agent.activity.updated | An agent’s activity status was changed. |
3030
| call.completed | An inbound or outbound call with a contact was completed. This includes calls that were not answered. |
31+
| call.recording.available | A call recording link is available. |
3132
| contact.subscribed | A contact was subscribed to a marketing channel. |
3233
| contact.unsubscribed | A contact was unsubscribed from a marketing channel. |
3334
| contact.attribute.edited | A contact's attributes were edited by an agent. |
@@ -39,7 +40,9 @@ The table below lists events that Regal Voice sends to Segment. These events app
3940
| sms.undelivered | An SMS was undelivered from Regal Voice to contact. |
4041
| sms.received | An SMS was received from a contact. |
4142
| task.canceled | A call or SMS task was canceled. |
42-
| task.created | A call or SMS task was created.
43+
| task.created | A call or SMS task was created. |
44+
| task.reservation.created | A reservation was created for a task. |
45+
| task.reservation.accepted | A reservation was accepted by an agent. |
4346

4447
## Event Properties
4548

@@ -79,7 +82,11 @@ The table below lists events that Regal Voice sends to Segment. These events app
7982
| `objections` | Task objections |
8083
| `phone` | The phone number the subscription updated was applied to; phone number is the unique identifier for a contact in Regal voice |
8184
| `queue` | Task Queue |
85+
| `recording_link` | Call recording link |
8286
| `regal_voice_phone` | Regal Voice phone number |
87+
| `regal_voice_phone_internal_name` | Internal name of phone line displayed to agents
88+
| `reserved_agent_email` | Email of the agent the task reservation is for
89+
| `reserved_agent_full_name` | Full name of the agent the task reservation is for
8390
| `scheduling_agent_email` | Email of the agent who scheduled the callback |
8491
| `scheduling_agent_fullname` | Full name of the agent who scheduled the callback |
8592
| `scheduling_agent_id` | Email of the agent who scheduled the callback |

src/personas/computed-traits.md

Lines changed: 5 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -146,7 +146,11 @@ The following operators are available.
146146

147147
## Connecting your Computed Trait to a Destination
148148

149-
Personas sends user-level computed Traits to destinations using the [Identify call](/docs/connections/spec/identify/) for user traits, or using the [Track call](/docs/connections/spec/track/) for event properties. Learn more about [Computed trait generated events here](/docs/personas/using-personas-data/#computed-trait-generated-events). The trait name corresponds to the snake cased name that you see in the trait settings, for example `most_viewed_page_category`. See the [list of Personas-compatible destinations](/docs/personas/using-personas-data/#compatible-personas-destinations)
149+
Personas sends user-level computed Traits to destinations using the [Identify call](/docs/connections/spec/identify/) for user traits, or using the [Track call](/docs/connections/spec/track/) for event properties. Segment includes the trait value and property in the identify and track calls.
150+
151+
For example, the name of a computed trait is added to the user profile as a trait, and the trait's value is set to the value of the computed trait. Segment sends an identify or track call when the trait is computed, depending on the destination configuration. If a computed trait counts the number of times a user visits your pricing page, and the user visits your pricing page five times, Segment sends an identify call with the property `pricing_page_visits: 5`.
152+
153+
Learn more about [Computed trait generated events here](/docs/personas/using-personas-data/#computed-trait-generated-events). The trait name corresponds to the snake cased name that you see in the trait settings, for example `most_viewed_page_category`. See the [list of Personas-compatible destinations](/docs/personas/using-personas-data/#compatible-personas-destinations)
150154

151155
![](images/1525837601768.png)
152156

vale-styles/segment/exclamation.yml

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,6 @@
1+
extends: substitution
2+
message: "Please use '%s' instead of '%s'."
3+
link: https://docs.microsoft.com/en-us/style-guide/punctuation/exclamation-points
4+
level: warning
5+
swap:
6+
'\w!\s': '\.'

vale-styles/segment/links.yml

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,6 @@
1+
extends: existence
2+
message: "Write meaningful link text."
3+
link: https://docs.microsoft.com/en-us/style-guide/urls-web-addresses
4+
level: warning
5+
raw:
6+
- '\[?here\]\('

vale-styles/segment/numbers.yml

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,6 @@
1+
extends: existence
2+
message: "Spell out numbers from zero to nine."
3+
link: https://docs.microsoft.com/en-us/style-guide/numbers
4+
level: warning
5+
raw:
6+
- '\s[0-9]\s|([0-9])-([0-9])'

0 commit comments

Comments
 (0)