Skip to content

Commit 18e061b

Browse files
pwsegpwseg
authoredSep 17, 2024
Merge pull request #7044 from segmentio/develop
Release 24.38.1
·
25.13.0124.38.1
2 parents 7b3905b + dec18d8 commit 18e061b

File tree

11 files changed

+188
-74
lines changed

11 files changed

+188
-74
lines changed
 

‎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-09-12
2+
# destination categories last updated 2024-09-17
33
items:
44
- display_name: A/B Testing
55
slug: a-b-testing

‎src/_data/catalog/destinations.yml

+65-65
Large diffs are not rendered by default.

‎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-09-12
2+
# destination data last updated 2024-09-17
33
items:
44
- id: 54521fd925e721e32a72eee1
55
display_name: Pardot

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

+9
Original file line numberDiff line numberDiff line change
@@ -817,6 +817,15 @@ sources:
817817
- us
818818
endpoints:
819819
- us
820+
- id: WGp9SQFRVu
821+
display_name: Quin AI
822+
hidden: false
823+
slug: quin-ai
824+
url: connections/sources/catalog/cloud-apps/quin-ai
825+
regions:
826+
- us
827+
endpoints:
828+
- us
820829
- id: bnpfpwKnhu
821830
display_name: Radar
822831
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-09-12
2+
# source categories last updated 2024-09-17
33
items:
44
- display_name: A/B Testing
55
slug: a-b-testing

‎src/_data/catalog/sources.yml

+21-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-09-12
2+
# sources last updated 2024-09-17
33
items:
44
- id: 8HWbgPTt3k
55
display_name: .NET
@@ -1858,6 +1858,26 @@ items:
18581858
- Personalization
18591859
status: PUBLIC
18601860
partnerOwned: true
1861+
- id: WGp9SQFRVu
1862+
display_name: Quin AI
1863+
isCloudEventSource: true
1864+
slug: quin-ai
1865+
url: connections/sources/catalog/cloud-apps/quin-ai
1866+
hidden: false
1867+
regions:
1868+
- us
1869+
endpoints:
1870+
- us
1871+
source_type: cloud-app
1872+
description: Real-time Visitor Behaviour Prediction
1873+
logo:
1874+
url: >-
1875+
https://cdn-devcenter.segment.com/8b8b10a0-5388-4818-85f6-1f81f01493b5.svg
1876+
categories:
1877+
- Personalization
1878+
- Enrichment
1879+
status: PUBLIC_BETA
1880+
partnerOwned: true
18611881
- id: bnpfpwKnhu
18621882
display_name: Radar
18631883
isCloudEventSource: true

‎src/connections/aws-privatelink.md

+2-2
Original file line numberDiff line numberDiff line change
@@ -5,7 +5,7 @@ title: Amazon Web Services PrivateLink
55
[Amazon Web Services' PrivateLink](https://aws.amazon.com/privatelink/){:target="_blank”} is an AWS service that provides private connectivity between VPCs without exposing traffic to the public Internet. Keeping traffic in the Amazon network reduces the data security risk associated with exposing your Warehouse traffic to the Internet.
66

77
> info ""
8-
> Segment's PrivateLink integration is currently in private beta and is governed by Segment’s [First Access and Beta Preview Terms](https://www.twilio.com/en-us/legal/tos){:target="_blank”}. Only warehouses located in region `us-east-1` are eligible for PrivateLink. You might incur additional networking costs while using AWS PrivateLink.
8+
> Segment's PrivateLink integration is currently in private beta and is governed by Segment’s [First Access and Beta Preview Terms](https://www.twilio.com/en-us/legal/tos){:target="_blank”}. Only warehouses located in regions `us-east-1`, `us-west-2`, or `eu-west-1` are eligible for PrivateLink. You might incur additional networking costs while using AWS PrivateLink.
99
1010
During the Private Beta, you can set up AWS PrivateLink for [Databricks](#databricks), [RDS Postgres](#rds-postgres), and [Redshift](#redshift).
1111

@@ -60,7 +60,7 @@ If any updates are made to the Availability Zones (AZs) enabled for your NLB, pl
6060
### Configure PrivateLink for Redshift
6161
Implement Segment's PrivateLink integration by taking the following steps:
6262
1. Let your Customer Success Manager (CSM) know that you're interested in PrivateLink. They will share information with you about Segment’s Edge account and VPC.
63-
2. After you receive the Edge account ID and VPC ID, [grant cluster access to Segment's Edge account and VPC](https://docs.aws.amazon.com/redshift/latest/gsg/rs-gsg-connect-to-cluster.html){:target="_blank”}.
63+
2. After you receive the Edge account ID and VPC ID, [grant cluster access to Segment's Edge account and VPC](https://docs.aws.amazon.com/redshift/latest/mgmt/managing-cluster-cross-vpc-console-grantor.html){:target="_blank”}.
6464
3. Reach back out to your CSM and provide them with the Cluster identifier for your cluster and your AWS account ID.
6565
4. Segment creates a Redshift managed VPC endpoint within the Segment Redshift subnet on your behalf, which creates a PrivateLink Endpoint URL. Segment then provides you with the internal PrivateLink Endpoint URL.
6666
5. After Segment provides you with the URL, use it to update or create new Redshift integrations. The following integrations support PrivateLink:

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

+83
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,83 @@
1+
---
2+
title: Quin AI Source
3+
id: WGp9SQFRVu
4+
---
5+
6+
Quin AI is the first deep learning, real-time behavior prediction system dedicated to e-commerce conversion optimization for growth and profitability.
7+
8+
This source is maintained by Quin Audience Engine. For any issues with the source, [contact the Quin Audience Engine Support team](mailto:hello@quinengine.com).
9+
10+
## Getting started
11+
12+
1. From your workspace's Source page, click **Add Source**.
13+
2. Search for "Quin AI" in the Sources Catalog, select Quin AI, and click **Add Source**.
14+
3. On the next screen, give the Source a name configure any other settings.
15+
- 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 Segment recommends using something that reflects the source itself and distinguishes amongst your environments (eg. QuinAI_Prod, QuinAI_Staging, QuinAI_Dev).
16+
4. Click **Add Source** to save your settings.
17+
5. Copy the Write key from the Segment UI.
18+
6. 6. Log in to your [Quin account](https://portal.quinengine.com/){:target="_blank”} and navigate to **Integrations > Segment > Settings**.
19+
7. On the Settings page, paste your Segment write key to connect.
20+
21+
## Stream
22+
23+
Quin AI uses a stream Source component and Track and Identify methods to send event data to Segment. These events are then available in any destination that accepts server-side events and as a schema in your data warehouse that you can query using SQL.
24+
25+
The default behavior is for Quin AI to pass the event data associated with the anonymousId.
26+
27+
## Events
28+
29+
The table below lists events that Quin sends to Segment. These events appear as tables in your warehouse and as regular events in other Destinations.
30+
31+
| Event Name | Description |
32+
|------------|------------------------------------|
33+
| Page View | Get an action after viewing a page |
34+
| Click | Get an action after a click |
35+
36+
37+
## Event Properties
38+
39+
The table below list the properties included in the events listed above.
40+
41+
| Property Name | Description |
42+
|-------------------------------|-------------------------------------------------------------|
43+
| `action_audience_id` | ID of the target audience for the action |
44+
| `action_control_group` | Boolean indicating if the action is part of a control group |
45+
| `action_id` | Unique identifier for the action |
46+
| `action_is_custom` | Boolean indicating if the action is custom |
47+
| `action_name` | Name of the action |
48+
| `action_type` | Type of the action |
49+
| `basket_price` | Total price of the items in the basket |
50+
| `basket_quantity` | Total quantity of items in the basket |
51+
| `event_action` | Type of event action (e.g., pageview, click) |
52+
| `event_category` | Category of the event |
53+
| `event_count` | Number of events |
54+
| `event_custom_attributes` | Map of custom attributes associated with the event |
55+
| `evet_duration` | Duration of the event in seconds |
56+
| `event_label` | Label of the event |
57+
| `event_platform` | Platform on which the event occurred (e.g., web, mobile) |
58+
| `event_timestamp` | Timestamp when the event occurred |
59+
| `event_url` | URL associated with the event |
60+
| `google_client_id` | Google Analytics client ID |
61+
| `item_category` | Category of the item |
62+
| `item_currency` | Currency of the item price (e.g., TRY) |
63+
| `item_custom_attributes` | Map of custom attributes associated with the item |
64+
| `item_id` | Unique identifier for the item |
65+
| `item_name` | Name of the item |
66+
| `item_price` | Price of the item |
67+
| `most_visited_category` | List of most visited categories |
68+
| `most_visited_category_count` | Number of times the most visited categories were visited |
69+
| `prediction` | Map of prediction probabilities for various outcomes |
70+
| `returning_user` | Boolean indicating if the user is a returning user |
71+
| `session_id` | Unique identifier for the session |
72+
| `utm_campaign` | UTM campaign parameter |
73+
| `utm_mdedium` | UTM medium parameter |
74+
| `utm_source` | UTM source parameter |
75+
76+
77+
## Adding Destinations
78+
79+
Now that your Source is set up, you can connect to Destinations.
80+
81+
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.
82+
83+
If there are any issues with how the events are arriving to Segment, [contact the Quin AI support team](mailto:hello@quinengine.com).

‎src/connections/sources/catalog/libraries/website/javascript/index.md

+3-1
Original file line numberDiff line numberDiff line change
@@ -362,7 +362,9 @@ analytics.identify("hello world")
362362

363363
The `ready` method lets you pass in a method that gets called after Analytics.js finishes initializing and after all enabled device-mode destinations load. It's like [jQuery's `ready` method](https://api.jquery.com/ready/){:target="_blank"}, except for Destinations. Because it doesn't fire until all enabled device-mode destinations are loaded, it can't be used to change configuration options for downstream SDKs. That can only be done if the SDK is loaded natively.
364364

365-
The `ready` method isn't invoked if any Destination throws an error (for example, for an expired API key, incorrect settings configuration, or when a Destination is blocked by the browser) during initialization. If you're looking to detect when Analytics.js has loaded, instead of using the `ready` method, you can listen for the `initialize` event to be emitted (`window.analytics.initialized`). This event returns `true` even when a destination is blocked.
365+
The `ready` method isn't invoked if any Destination throws an error (for example, for an expired API key, incorrect settings configuration, or when a Destination is blocked by the browser) during initialization. If you want to check when Analytics.js has loaded, you can look at the value of `window.analytics.initialized`. When it’s true, the library has successfully initialized, even if some destinations are blocked.
366+
367+
**Note**: `window.analytics.initialized` is a simple boolean, not an event or a pub/sub system. This means you can't subscribe to changes in its value. If you need to detect when it changes from `false` to `true`, you must set up a polling mechanism to monitor the value.
366368

367369
The code in the `ready` function only executes after `ready` is emitted.
368370

‎src/connections/spec/common.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -139,7 +139,7 @@ Context is a dictionary of extra information that provides useful context about
139139
| `active` | Boolean | Whether a user is active. <br><br> This is usually used to flag an `.identify()` call to just update the traits but not "last seen." |
140140
| `app` | Object | dictionary of information about the current application, containing `name`, `version`, and `build`. <br><br> This is collected automatically from the mobile libraries when possible. |
141141
| `campaign` | Object | Dictionary of information about the campaign that resulted in the API call, containing `name`, `source`, `medium`, `term`, `content`, and any other custom UTM parameter. <br><br> This maps directly to the common UTM campaign parameters. |
142-
| `device` | Object | Dictionary of information about the device, containing `id`, `advertisingId`, `manufacturer`, `model`, `name`, `type`, and `version`. |
142+
| `device` | Object | Dictionary of information about the device, containing `id`, `advertisingId`, `manufacturer`, `model`, `name`, `type`, and `version`. <br><br> **Note:** If you collect information about iOS devices, note that the `model` value set by Apple might not exactly correspond to an iPhone model number. For example, an `iPhone 15 Pro Max` has a `model` value of `iPhone16,2`. |
143143
| `ip` | String | Current user's IP address. |
144144
| `library` | Object | Dictionary of information about the library making the requests to the API, containing `name` and `version`. |
145145
| `locale` | String | Locale string for the current user, for example `en-US`. |

‎src/privacy/user-deletion-and-suppression.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -75,7 +75,7 @@ Note that list only includes `SUPPRESS_ONLY` regulations. If you created a User
7575

7676
To create a suppression regulation and add a `userId` to this list, click **Suppress New User**, and enter the `userId` in the field that appears. Then click **Request Suppression**.
7777

78-
Segment creates a `SUPPRESS` regulation, and adds the `userId` to your suppression list, mostly processed within 24 hours. In some cases, the suppression request can take up to 30 days to process.
78+
Segment creates a `SUPPRESS` regulation, and adds the `userId` to your suppression list, mostly processed within 24 hours. In some cases, the suppression request can take up to 30 days to process. You can suppress up to 5000 userIds per call through the Public API.
7979

8080
### Remove a user from the suppression list
8181

0 commit comments

Comments
 (0)
Please sign in to comment.