Skip to content

Commit dbf531b

Browse files
cmastrcmastr
authored
Merge pull request segmentio#6251 from segmentio/develop
Release 24.12.1
2 parents 31861e4 + 2c045a1 commit dbf531b

File tree

29 files changed

+276
-29
lines changed

29 files changed

+276
-29
lines changed

‎src/_data/actions/braze-cloud.yml

+1-1
Original file line numberDiff line numberDiff line change
@@ -173,7 +173,7 @@ actions:
173173
description: Set to true to use the Braze API in "Update Only" mode.
174174
default: false
175175
- action: Track Purchase
176-
blurb: Track Purchase sends Braze a Track Purchase call when the destination recieves any event that matches the specified name.
176+
blurb: Track Purchase sends Braze a Track Purchase call when the destination receives any event that matches the specified name.
177177
fields:
178178
- name: Time
179179
description: The timestamp of when the event occured.

‎src/_data/actions/braze-web.yml

+1-1
Original file line numberDiff line numberDiff line change
@@ -221,7 +221,7 @@ actions:
221221
description: Set to true to use the Braze API in "Update Only" mode.
222222
default: false
223223
- action: Track Purchase
224-
blurb: Track Purchase sends Braze a Track Purchase call when the destination recieves any event named `Order Completed`.
224+
blurb: Track Purchase sends Braze a Track Purchase call when the destination receives any event named `Order Completed`.
225225
fields:
226226
- name: Time
227227
description: The timestamp of when the event occured.

‎src/_data/catalog/destination_categories.yml

+1-1
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
11
# AUTOGENERATED FROM PUBLIC API. DO NOT EDIT
2-
# destination categories last updated 2024-03-14
2+
# destination categories last updated 2024-03-19
33
items:
44
- display_name: A/B Testing
55
slug: a-b-testing

‎src/_data/catalog/destinations.yml

+58-1
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
11
# AUTOGENERATED FROM PUBLIC API. DO NOT EDIT
2-
# destination data last updated 2024-03-14
2+
# destination data last updated 2024-03-19
33
items:
44
- id: 637e8d185e2dec264895ea89
55
display_name: 1Flow
@@ -60154,6 +60154,63 @@ items:
6015460154
label: Events
6015560155
actions: []
6015660156
presets: []
60157+
- id: 65e8b496eec9c40dbccbf749
60158+
display_name: MetricStory
60159+
name: MetricStory
60160+
slug: metricstory
60161+
hidden: false
60162+
endpoints:
60163+
- US
60164+
regions:
60165+
- us-west-2
60166+
- eu-west-1
60167+
url: connections/destinations/catalog/metricstory
60168+
previous_names:
60169+
- MetricStory
60170+
website: http://www.metricstory.ai
60171+
status: PUBLIC_BETA
60172+
categories:
60173+
- Analytics
60174+
- Analytics
60175+
logo:
60176+
url: https://cdn-devcenter.segment.com/e1a77986-7c66-45d2-a7b7-a850dee73f0a.svg
60177+
mark:
60178+
url: https://cdn-devcenter.segment.com/68c979e1-b86a-4317-bd82-9a821aabf0b1.svg
60179+
methods:
60180+
track: false
60181+
identify: false
60182+
group: false
60183+
alias: false
60184+
screen: false
60185+
page: false
60186+
platforms:
60187+
browser: true
60188+
mobile: true
60189+
server: true
60190+
warehouse: false
60191+
cloudAppObject: false
60192+
components: []
60193+
browserUnbundlingSupported: false
60194+
browserUnbundlingPublic: false
60195+
replay: false
60196+
connection_modes:
60197+
device:
60198+
web: false
60199+
mobile: false
60200+
server: false
60201+
cloud:
60202+
web: true
60203+
mobile: true
60204+
server: true
60205+
settings:
60206+
- name: apiKey
60207+
type: string
60208+
defaultValue: ''
60209+
description: Your MetricStory API key
60210+
required: true
60211+
label: API Key
60212+
actions: []
60213+
presets: []
6015760214
- id: 61a8032ea5f157ee37a720be
6015860215
display_name: Metronome (Actions)
6015960216
name: Metronome (Actions)

‎src/_data/catalog/destinations_private.yml

+1-1
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
11
# AUTOGENERATED FROM PUBLIC API. DO NOT EDIT
2-
# destination data last updated 2024-03-14
2+
# destination data last updated 2024-03-19
33
items:
44
- id: 54521fd925e721e32a72eee1
55
display_name: Pardot

‎src/_data/catalog/regional-supported.yml

+10-1
Original file line numberDiff line numberDiff line change
@@ -98,7 +98,7 @@ sources:
9898
- us
9999
- id: xNpohElkX2
100100
display_name: Azure
101-
hidden: true
101+
hidden: false
102102
slug: azure
103103
url: connections/sources/catalog/cloud-apps/azure
104104
regions:
@@ -957,6 +957,15 @@ sources:
957957
- us
958958
endpoints:
959959
- us
960+
- id: OyAdFUfMz9
961+
display_name: Synap
962+
hidden: false
963+
slug: synap
964+
url: connections/sources/catalog/cloud-apps/synap
965+
regions:
966+
- us
967+
endpoints:
968+
- us
960969
- id: 43bb279b7
961970
display_name: Twilio
962971
hidden: false

‎src/_data/catalog/source_categories.yml

+1-1
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
11
# AUTOGENERATED FROM PUBLIC API. DO NOT EDIT
2-
# source categories last updated 2024-03-14
2+
# source categories last updated 2024-03-19
33
items:
44
- display_name: A/B Testing
55
slug: a-b-testing

‎src/_data/catalog/sources.yml

+19-1
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
11
# AUTOGENERATED FROM PUBLIC API. DO NOT EDIT
2-
# sources last updated 2024-03-14
2+
# sources last updated 2024-03-19
33
items:
44
- id: 8HWbgPTt3k
55
display_name: .NET
@@ -1964,6 +1964,24 @@ items:
19641964
categories:
19651965
- Surveys
19661966
- Customer Success
1967+
- id: OyAdFUfMz9
1968+
display_name: Synap
1969+
isCloudEventSource: true
1970+
slug: synap
1971+
url: connections/sources/catalog/cloud-apps/synap
1972+
hidden: false
1973+
regions:
1974+
- us
1975+
endpoints:
1976+
- us
1977+
source_type: cloud-app
1978+
description: Online learning and assessments
1979+
logo:
1980+
url: >-
1981+
https://cdn-devcenter.segment.com/685e8ea7-1bd7-4907-ae02-05e2ce099134.svg
1982+
categories:
1983+
- Learning Management System
1984+
- Performance Monitoring
19671985
- id: 43bb279b7
19681986
display_name: Twilio
19691987
isCloudEventSource: false

‎src/connections/destinations/catalog/actions-google-sheets/index.md

+4
Original file line numberDiff line numberDiff line change
@@ -38,3 +38,7 @@ The Record Identifier mapping is used to make a distinction between adding a new
3838
### How do I define the columns in my spreadsheet?
3939

4040
The Fields mapping controls which fields in your model will be written as columns. Input the desired column name(s) on the left, and select the data variable that will populate the value for that column on the right. Please note, at least one field must be configured to send data to Google Sheets otherwise no columns will be created or synced.
41+
42+
### How are columns formatted when synced to my spreadsheet?
43+
44+
When syncing data to Google Sheets, the columns will be arranged alphabetically, based on the names defined in the Fields mapping.

‎src/connections/destinations/catalog/autopilotapp/index.md

+3-2
Original file line numberDiff line numberDiff line change
@@ -13,7 +13,8 @@ This destination is maintained by Ortto. For any issues with the destination, [c
1313

1414
## Getting Started
1515

16-
16+
> info ""
17+
> You need Workspace Owner permissions to create the Ortto destination through OAuth on Ortto's website.
1718
1819
1. From the Destinations catalog page in the Segment App, click **Add Destination**.
1920
2. Search for "Ortto" in the Destinations Catalog, and select the "Ortto" destination.
@@ -52,4 +53,4 @@ analytics.track('Login Button Clicked', {
5253
});
5354
```
5455

55-
Segment sends Track calls to Ortto as a `track` event.
56+
Segment sends Track calls to Ortto as a `track` event.

‎src/connections/destinations/catalog/braze/index.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -353,7 +353,7 @@ The `inAppMessages` parameter will be an array of [`appboy.ab.InAppMessage`](htt
353353
// When you get the push token
354354
String receivedToken;
355355

356-
appboyPushToken = recievedToken;
356+
appboyPushToken = receivedToken;
357357
if (appboyInitialized) {
358358
Appboy.getInstance(getContext()).registerAppboyPushMessages(appboyPushToken);
359359
}

‎src/connections/destinations/catalog/google-analytics/index.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -839,7 +839,7 @@ To enable user deletion for Google Universal Analytics:
839839
2. Authenticate your Google Universal Analytics account using OAuth.
840840

841841
> info ""
842-
> **NOTE:** Segment supports user deletion for Google Universal Analytics in Universal Analytics and not Classic Analytics. You can send user deletion requests using a `userId` through the Privacy Tool. This means you must have the User-Id feature enabled in your Google Universal Analytics Property within the your Google Universal Analytics dashboard and have Segment sending your Property `userIds` by enabling the setting **Send User-ID to GA**.
842+
> **NOTE:** Segment supports user deletion for Google Universal Analytics in Universal Analytics and not Classic Analytics. You can send user deletion requests using a `userId` through the Privacy Tool. This means you must have the User-Id feature enabled in your Google Universal Analytics Property within your Google Universal Analytics dashboard and have Segment sending your Property `userIds` by enabling the setting **Send User-ID to GA**.
843843
844844

845845

‎src/connections/destinations/catalog/metricstory/index.md

+43
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,43 @@
1+
---
2+
title: MetricStory Destination
3+
id: 65e8b496eec9c40dbccbf749
4+
beta: true
5+
---
6+
7+
[MetricStory](https://www.metricstory.ai){:target="_blank”} lets you run AI on your product analytics, create and generate charts, and analyze data in minutes.
8+
9+
MetricStoryAI maintains this destination. For any issues with the destination, contact the [MetricStory support team]([email protected]).
10+
11+
## Getting started
12+
1. From the Destination catalog page in the Segment app, search for MetricStory.
13+
2. Select and click **Add Destination**.
14+
3. Select an existing source to connect to.
15+
4. Go to the [API Keys](https://www.metricstory.ai/account/apikeys){:target="_blank"} page in MetricStory.ai.
16+
5. Copy your API key
17+
6. Enter the API key in the destination settings in Segment.
18+
19+
## Supported methods
20+
MetricStory supports the following methods, as specified in the [Segment Spec](/docs/connections/spec).
21+
22+
### Page
23+
The Page method triggers a call to Segment's `page` method which lets users query drop off in the funnel.
24+
25+
```js
26+
analytics.page()
27+
```
28+
29+
### Identify
30+
The Identify call identifies users for tracking purposes within MetricStory. MetricStory uses this data to group users together in cohorts, track individual user data, and more.
31+
32+
```js
33+
analytics.identify('userId123', {
34+
email: '[email protected]'
35+
});
36+
```
37+
38+
### Track
39+
MetricStory uses this data to understand how users are interacting with apps and lets users query data with AI through the events.
40+
41+
```js
42+
analytics.track('Login Button Clicked')
43+
```

‎src/connections/destinations/catalog/mixpanel/index.md

+8
Original file line numberDiff line numberDiff line change
@@ -496,6 +496,14 @@ If you're testing in Xcode remember you must first background the app, then the
496496
In Device-mode, when a `distinct_id` is present in the browser, it is automatically sent to Mixpanel. In Cloud-mode, the `distinct_id` is set to Segment's `userId` if one is present. If there is no `userId` on the payload, `anonymousId` is set instead.
497497

498498

499+
### Insert ID
500+
501+
`$insert_id` is only available for cloud events. For the Mixpanel (Legacy) destination, Segment generates `$insert_id` from the messageId, event name, and Mixpanel namespace constant using the [uuidv5](https://developer.hashicorp.com/terraform/language/functions/uuidv5) function:
502+
```javascript
503+
const insertId = uuidv5(`${messageId}:${projectId}:${eventName}`, MIXPANEL_NAMESPACE)
504+
```
505+
506+
499507
### IP
500508

501509
If an `ip` property is passed to Mixpanel, the value will be interpreted as the IP address of the request and therefore automatically parsed into Mixpanel geolocation properties (City, Country, Region). After that IP address has been parsed, they will throw out the IP address and only hold onto those resulting geolocation properties. As such, if you want to display an IP address as a property within the Mixpanel UI or within raw data, you will simply want to slightly modify the naming convention for that property.

‎src/connections/destinations/catalog/split/index.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -94,4 +94,4 @@ Each event may have a `value` field which you would like to use in Split metric
9494

9595
If you would not like Split to receive `track` calls, you can configure in your integration settings in Split.
9696

97-
_**NOTE:** Split currently does not capture the properties of the your track events. The Split team is currently working to accept these properties for use in creating metrics in Split._
97+
_**NOTE:** Split currently does not capture the properties of your track events. The Split team is currently working to accept these properties for use in creating metrics in Split._

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

+1-1
Original file line numberDiff line numberDiff line change
@@ -87,7 +87,7 @@ SendGrid powers Engage email delivery. For more information, view [SendGrid's Ev
8787

8888
| Event | Definition |
8989
| ---------------------------- | ----------------------------------------------------- |
90-
| WhatsApp Message Queued | The WhatsApp message creation requested was recieved. |
90+
| WhatsApp Message Queued | The WhatsApp message creation requested was received. |
9191
| WhatsApp Message Accepted | The WhatsApp message creation request was accepted. |
9292
| WhatsApp Message Sending | The WhatsApp message is being sent. |
9393
| WhatsApp Message Sent | The WhatsApp message was successfully sent. |

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

+1-1
Original file line numberDiff line numberDiff line change
@@ -20,7 +20,7 @@ Before you start, make sure that you have admin rights in Freshchat and [Workspa
2020
5. Copy the Write key from the Segment UI to use in Freshchat.
2121
6. Log in to your Freshchat account.
2222
7. In Freshchat, navigate to Admin → Marketplace Apps → Segment Integration.
23-
8. Paste the your Segment write key and click **Authenticate account** to connect.
23+
8. Paste your Segment write key and click **Authenticate account** to connect.
2424
9. After your account is authenticated, select one or more of the following events to send to Segment:
2525
- On Agent Activity Create
2626
- On Conversation Create

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

+89
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,89 @@
1+
---
2+
title: Synap Source
3+
id: OyAdFUfMz9
4+
beta: true
5+
---
6+
7+
[Synap](https://synap.ac){:target="_blank”} is an online exam platform specialising in the delivery of high stakes exams, assessments and online learning. Synap is used by a wide range of companies and educational institutions to deliver high quality, robust assessments.
8+
9+
This source is maintained by Synap. For any issues with the source, contact Synap via the live chat widget available on your portal, or get in touch with your account manager. Synap also provides more [detailed documentation on their website](https://academy.synap.ac/doc/integrations/segment){:target="_blank”} with specific guides and best practices.
10+
11+
## Getting started
12+
13+
1. From your workspace's Sources page, click **Add source**.
14+
15+
2. Search for and select Synap.
16+
17+
3. Copy the Write key from the Segment UI.
18+
19+
4. Login to your Synap portal as an admin, and go to `/portal-dashboard/settings/integrations`. To navigate to this page via the UI, first click on the 'gears' icon near the bottom left hand side of the screen, then look for the Integrations menu item.
20+
21+
5. Paste your write key into the Segment Write Key box and click **Save** - this verifies and saves your API key.
22+
23+
## Stream
24+
25+
Synap uses their stream Source component to send Segment event data. On the client-side, this source uses Segment's Identify and Page events. On the server-side, it uses Identify and Track events. These events are then available in any Segment destination that accepts client or server-side events and available in a schema in your data warehouse that you can query using SQL.
26+
27+
Synap identifies users based on their Synap User ID, which is sent as the userId in Segment events.
28+
29+
## Events
30+
31+
The table below lists events that Synap sends to Segment. These events appear as tables in your warehouse, and as regular events in other destinations. Synap includes the userId, if available.
32+
33+
| Event Name | Description |
34+
| ---------------------- | ----------------------------------------------------------------- |
35+
| Began Test | User starts a test |
36+
| Submitted Test | User finishes ('submits') a test (may or may not require marking) |
37+
| Completed Test | When a Test has been 'completed' (including marking) |
38+
| Collection Item Viewed | User views a Collection Item |
39+
| User Registered | User registered an Account |
40+
| Assignment Started | User starts an Assignment |
41+
| Exam User Registered | User is enrolled for an Exam |
42+
| User Logged In | User explicitly logged in to Synap |
43+
| User Session Restored | User opened Synap after a period of in activity |
44+
45+
To find the list of properties associated with the events, please refer to the [Synap Segment Documentation](https://academy.synap.ac/doc/integrations/segment){:target="_blank”}. Some of the events, notably those related to Test and Question submission, have relatively large payloads. You might want to review the [Synap Test and Question Analytics Schemas](https://academy.synap.ac/doc/integrations/segment/test-and-question-analytics){:target="_blank"} before tracking these events.
46+
47+
## Identify
48+
49+
Synap sends an identify() message to Segment which consists of the userId and the user traits.
50+
51+
| Field | Type | Description |
52+
| ------- | ------ | ------------------------------------------------------------------------------------- |
53+
| userId | string | Unique identifier for the user in Synap |
54+
| context | object | User [context](https://segment.com/docs/connections/spec/common/#context) |
55+
| traits | object | Custom [traits](https://segment.com/docs/connections/spec/common/#traits) of the user |
56+
57+
### Identify traits
58+
59+
| Name | Type | Description |
60+
| ---------------------- | ----------------------------------- | ----------------------------------------------------------------------- |
61+
| createdAt | date | The date this user's account was created |
62+
| email | string | The user's email address |
63+
| emailVerified | boolean | Whether or not the user has verified their email address |
64+
| firstName | string | The user's first name |
65+
| lastName | string | The user's last name |
66+
| marketingEmailsConsent | "removed", "pending" or "confirmed" | Enumeration representing the user's consent to receive marketing emails |
67+
| name | string | The user's full name |
68+
| profilePicture | string | a URL pointing to the user's profile picture, if provided |
69+
70+
71+
## Page
72+
73+
Page calls include the page path and unique URL.
74+
75+
| Name | Type | Description |
76+
| ------ | ------ | ---------------------------------------- |
77+
| name | string | The name of the page |
78+
| path | string | The relative path to the page |
79+
| search | string | Any query string parameters from the URL |
80+
| title | string | The title of the page |
81+
| url | string | The full URL of the page |
82+
83+
## Adding destinations
84+
85+
Now that your source is set up, you can connect it to destinations.
86+
87+
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 tool, and refer to the destination docs for each tool for troubleshooting.
88+
89+
If there are any issues with how the events are arriving to Segment, contact the Synap support team via the live chat widget which is available to all Admin users of your portal.

‎src/connections/sources/catalog/libraries/mobile/apple/index.md

+3
Original file line numberDiff line numberDiff line change
@@ -159,6 +159,9 @@ Analytics for Swift is built with extensibility in mind. Use the tools list belo
159159
- [Destination Filters](/docs/connections/sources/catalog/libraries/mobile/swift/swift-destination-filters)
160160
- [Code samples](/docs/connections/sources/catalog/libraries/mobile/swift/swift-samples)
161161
162+
## Proxying events
163+
If you proxy your events through the `apiHost` config option, you must forward the batched events to `https://api.segment.io/v1/b`. The `https://api.segment.io/v1/batch` endpoint is reserved for events arriving from server-side sending, and proxying to that endpoint for your mobile events may result in unexpected behavior.
164+
162165
> warning ""
163166
> If you are using the Analytics iOS (Classic) SDK, you can find [the documentation here](/docs/connections/sources/catalog/libraries/mobile/ios). Many of the features available in the Analytics-Swift SDK are not available in the Analytics iOS (Classic) SDK.
164167

0 commit comments

Comments
 (0)