From b79d8057d0bffdb87aa13dbf8df6371e03b05fc0 Mon Sep 17 00:00:00 2001 From: eren-quinengine Date: Tue, 27 Aug 2024 16:30:27 +0300 Subject: [PATCH 1/5] Create documentation for Quin AI source integration --- .../catalog/cloud-apps/quin-ai/index.md | 85 +++++++++++++++++++ 1 file changed, 85 insertions(+) create mode 100644 src/connections/sources/catalog/cloud-apps/quin-ai/index.md diff --git a/src/connections/sources/catalog/cloud-apps/quin-ai/index.md b/src/connections/sources/catalog/cloud-apps/quin-ai/index.md new file mode 100644 index 0000000000..ad29217157 --- /dev/null +++ b/src/connections/sources/catalog/cloud-apps/quin-ai/index.md @@ -0,0 +1,85 @@ +# Quin AI Documentation + +--- +Quin AI Source +--- + +Quin AI is the first deep learning, real-time behaviour prediction system dedicated to e-commerce conversion optimisation, for growth and profitability. + +This source is maintained by Quin Audience Engine. For any issues with the source, [contact their Support team](mailto:hello@quinengine.com). + +## Getting started + +1. From your workspace's Source page, click **Add Source**. +2. Search for "Quin AI" in the Sources Catalog, select Quin AI, and click **Add Source**. +3. On the next screen, give the Source a name configure any other settings. + +- 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. SourceName_Prod, SourceName_Staging, SourceName_Dev). + +4. Click **Add Source** to save your settings. +5. Copy the Write key from the Segment UI. +6. Log in to your [Quin account](https://portal.quinengine.com/) - navigate to Integrations > Segment > Settings and paste the write key to connect. + +## Stream + +Quin AI uses our stream Source component to send Segment event data. It uses a server-side `track` and `identify` method(s) to send data to Segment. These events are then available in any destination that accepts server-side events, and available in a schema in your data warehouse, so you can query using SQL. + +The default behavior is for Quin AI to pass the event data associated with the anonymous userId. + +## Events + +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. + +| Event Name | Description | +|--------------------|------------------------------------| +| pageview | Get an action after viewing a page | +| click | Get an action after a click | + + +## Event Properties + +The table below list the properties included in the events listed above. + +| Property Name | Description | +|----------------------------|-------------------------------------------------------------| +| `ActionAudienceId` | ID of the target audience for the action | +| `ActionControlGroup` | Boolean indicating if the action is part of a control group | +| `ActionId` | Unique identifier for the action | +| `ActionIsCustom` | Boolean indicating if the action is custom | +| `ActionName` | Name of the action | | | +| `ActionType` | Type of the action | | | +| `BasketPrice` | Total price of the items in the basket | | | +| `BasketQuantity` | Total quantity of items in the basket | | | +| `EventAction` | Type of event action (e.g., pageview, click) | | | +| `EventCategory` | Category of the event | | | | | +| `EventCount` | Number of events | | | | | +| `EventCustomAttributes` | Map of custom attributes associated with the event | | | | | +| `EventDuration` | Duration of the event in seconds | | | | | +| `EventLabel` | Label of the event | | | | | +| `EventPlatform` | Platform on which the event occurred (e.g., web, mobile) | | | | | +| `EventTimestamp` | Timestamp when the event occurred | | | | | +| `EventURL` | URL associated with the event | | | | | +| `GoogleClientId` | Google Analytics client ID | | | | | +| `ItemCategory` | Category of the item | | +| `ItemCurrency` | Currency of the item price (e.g., TRY) | | +| `ItemCustomAttributes` | Map of custom attributes associated with the item | | +| `ItemId` | Unique identifier for the item | | +| `ItemName` | Name of the item | | +| `ItemPrice` | Price of the item | | +| `MostVisitedCategory` | List of most visited categories | | +| `MostVisitedCategoryCount` | Number of times the most visited categories were visited | | +| `Prediction` | Map of prediction probabilities for various outcomes | +| `ReturningUser` | Boolean indicating if the user is a returning user | | +| `SessionId` | Unique identifier for the session | | +| `UTMCampaign` | UTM campaign parameter | | +| `UTMMedium` | UTM medium parameter | | +| `UTMSource` | UTM source parameter | | + + +## Adding Destinations + +Now that your Source is set up, you can connect it with Destinations. + +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 there are any issues with how the events are arriving to Segment, [contact the Quin AI support team](mailto:hello@ Date: Wed, 28 Aug 2024 11:11:25 +0300 Subject: [PATCH 2/5] Adjust documentation for Quin AI source integration --- .../catalog/cloud-apps/quin-ai/index.md | 74 +++++++++---------- 1 file changed, 35 insertions(+), 39 deletions(-) diff --git a/src/connections/sources/catalog/cloud-apps/quin-ai/index.md b/src/connections/sources/catalog/cloud-apps/quin-ai/index.md index ad29217157..57aaf9663e 100644 --- a/src/connections/sources/catalog/cloud-apps/quin-ai/index.md +++ b/src/connections/sources/catalog/cloud-apps/quin-ai/index.md @@ -1,28 +1,24 @@ -# Quin AI Documentation ---- -Quin AI Source ---- +### Quin AI Source -Quin AI is the first deep learning, real-time behaviour prediction system dedicated to e-commerce conversion optimisation, for growth and profitability. +Quin AI is the first deep learning, real-time behavior prediction system dedicated to e-commerce conversion optimization, for growth and profitability. -This source is maintained by Quin Audience Engine. For any issues with the source, [contact their Support team](mailto:hello@quinengine.com). +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). ## Getting started 1. From your workspace's Source page, click **Add Source**. 2. Search for "Quin AI" in the Sources Catalog, select Quin AI, and click **Add Source**. 3. On the next screen, give the Source a name configure any other settings. - -- 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. SourceName_Prod, SourceName_Staging, SourceName_Dev). - + - 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. SourceName_Prod, SourceName_Staging, SourceName_Dev). 4. Click **Add Source** to save your settings. 5. Copy the Write key from the Segment UI. -6. Log in to your [Quin account](https://portal.quinengine.com/) - navigate to Integrations > Segment > Settings and paste the write key to connect. +6. Log in to your [Quin account](https://portal.quinengine.com/) and navigate to Integrations > Segment > Settings. +7. On the Settings page, paste your Segment write key to connect. ## Stream -Quin AI uses our stream Source component to send Segment event data. It uses a server-side `track` and `identify` method(s) to send data to Segment. These events are then available in any destination that accepts server-side events, and available in a schema in your data warehouse, so you can query using SQL. +Quin AI uses a stream Source component to send Segment event data. It uses server-side Track and Identify methods to send data to Segment. These events are then available in any destination that accepts server-side events and available in a schema in your data warehouse that you can query using SQL. The default behavior is for Quin AI to pass the event data associated with the anonymous userId. @@ -46,39 +42,39 @@ The table below list the properties included in the events listed above. | `ActionControlGroup` | Boolean indicating if the action is part of a control group | | `ActionId` | Unique identifier for the action | | `ActionIsCustom` | Boolean indicating if the action is custom | -| `ActionName` | Name of the action | | | -| `ActionType` | Type of the action | | | -| `BasketPrice` | Total price of the items in the basket | | | -| `BasketQuantity` | Total quantity of items in the basket | | | -| `EventAction` | Type of event action (e.g., pageview, click) | | | -| `EventCategory` | Category of the event | | | | | -| `EventCount` | Number of events | | | | | -| `EventCustomAttributes` | Map of custom attributes associated with the event | | | | | -| `EventDuration` | Duration of the event in seconds | | | | | -| `EventLabel` | Label of the event | | | | | -| `EventPlatform` | Platform on which the event occurred (e.g., web, mobile) | | | | | -| `EventTimestamp` | Timestamp when the event occurred | | | | | -| `EventURL` | URL associated with the event | | | | | -| `GoogleClientId` | Google Analytics client ID | | | | | -| `ItemCategory` | Category of the item | | -| `ItemCurrency` | Currency of the item price (e.g., TRY) | | -| `ItemCustomAttributes` | Map of custom attributes associated with the item | | -| `ItemId` | Unique identifier for the item | | -| `ItemName` | Name of the item | | -| `ItemPrice` | Price of the item | | -| `MostVisitedCategory` | List of most visited categories | | -| `MostVisitedCategoryCount` | Number of times the most visited categories were visited | | +| `ActionName` | Name of the action | +| `ActionType` | Type of the action | +| `BasketPrice` | Total price of the items in the basket | +| `BasketQuantity` | Total quantity of items in the basket | +| `EventAction` | Type of event action (e.g., pageview, click) | +| `EventCategory` | Category of the event | +| `EventCount` | Number of events | +| `EventCustomAttributes` | Map of custom attributes associated with the event | +| `EventDuration` | Duration of the event in seconds | +| `EventLabel` | Label of the event | +| `EventPlatform` | Platform on which the event occurred (e.g., web, mobile) | +| `EventTimestamp` | Timestamp when the event occurred | +| `EventURL` | URL associated with the event | +| `GoogleClientId` | Google Analytics client ID | +| `ItemCategory` | Category of the item | +| `ItemCurrency` | Currency of the item price (e.g., TRY) | +| `ItemCustomAttributes` | Map of custom attributes associated with the item | +| `ItemId` | Unique identifier for the item | +| `ItemName` | Name of the item | +| `ItemPrice` | Price of the item | +| `MostVisitedCategory` | List of most visited categories | +| `MostVisitedCategoryCount` | Number of times the most visited categories were visited | | `Prediction` | Map of prediction probabilities for various outcomes | -| `ReturningUser` | Boolean indicating if the user is a returning user | | -| `SessionId` | Unique identifier for the session | | -| `UTMCampaign` | UTM campaign parameter | | -| `UTMMedium` | UTM medium parameter | | -| `UTMSource` | UTM source parameter | | +| `ReturningUser` | Boolean indicating if the user is a returning user | +| `SessionId` | Unique identifier for the session | +| `UTMCampaign` | UTM campaign parameter | +| `UTMMedium` | UTM medium parameter | +| `UTMSource` | UTM source parameter | ## Adding Destinations -Now that your Source is set up, you can connect it with Destinations. +Now that your Source is set up, you can connect to Destinations. 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. From 75e19dcc57a8deae0676d4fbc2dfdadcb792a247 Mon Sep 17 00:00:00 2001 From: eren-quinengine Date: Mon, 16 Sep 2024 11:13:20 +0300 Subject: [PATCH 3/5] Adjust documentation for Quin AI source integration --- .../catalog/cloud-apps/quin-ai/index.md | 76 +++++++++---------- 1 file changed, 38 insertions(+), 38 deletions(-) diff --git a/src/connections/sources/catalog/cloud-apps/quin-ai/index.md b/src/connections/sources/catalog/cloud-apps/quin-ai/index.md index 57aaf9663e..a11fa4c8e3 100644 --- a/src/connections/sources/catalog/cloud-apps/quin-ai/index.md +++ b/src/connections/sources/catalog/cloud-apps/quin-ai/index.md @@ -26,50 +26,50 @@ The default behavior is for Quin AI to pass the event data associated with the a 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. -| Event Name | Description | -|--------------------|------------------------------------| -| pageview | Get an action after viewing a page | -| click | Get an action after a click | +| Event Name | Description | +|------------|------------------------------------| +| Page View | Get an action after viewing a page | +| Click | Get an action after a click | ## Event Properties The table below list the properties included in the events listed above. -| Property Name | Description | -|----------------------------|-------------------------------------------------------------| -| `ActionAudienceId` | ID of the target audience for the action | -| `ActionControlGroup` | Boolean indicating if the action is part of a control group | -| `ActionId` | Unique identifier for the action | -| `ActionIsCustom` | Boolean indicating if the action is custom | -| `ActionName` | Name of the action | -| `ActionType` | Type of the action | -| `BasketPrice` | Total price of the items in the basket | -| `BasketQuantity` | Total quantity of items in the basket | -| `EventAction` | Type of event action (e.g., pageview, click) | -| `EventCategory` | Category of the event | -| `EventCount` | Number of events | -| `EventCustomAttributes` | Map of custom attributes associated with the event | -| `EventDuration` | Duration of the event in seconds | -| `EventLabel` | Label of the event | -| `EventPlatform` | Platform on which the event occurred (e.g., web, mobile) | -| `EventTimestamp` | Timestamp when the event occurred | -| `EventURL` | URL associated with the event | -| `GoogleClientId` | Google Analytics client ID | -| `ItemCategory` | Category of the item | -| `ItemCurrency` | Currency of the item price (e.g., TRY) | -| `ItemCustomAttributes` | Map of custom attributes associated with the item | -| `ItemId` | Unique identifier for the item | -| `ItemName` | Name of the item | -| `ItemPrice` | Price of the item | -| `MostVisitedCategory` | List of most visited categories | -| `MostVisitedCategoryCount` | Number of times the most visited categories were visited | -| `Prediction` | Map of prediction probabilities for various outcomes | -| `ReturningUser` | Boolean indicating if the user is a returning user | -| `SessionId` | Unique identifier for the session | -| `UTMCampaign` | UTM campaign parameter | -| `UTMMedium` | UTM medium parameter | -| `UTMSource` | UTM source parameter | +| Property Name | Description | +|-------------------------------|-------------------------------------------------------------| +| `action_audience_id` | ID of the target audience for the action | +| `action_control_group` | Boolean indicating if the action is part of a control group | +| `action_id` | Unique identifier for the action | +| `action_is_custom` | Boolean indicating if the action is custom | +| `action_name` | Name of the action | +| `action_type` | Type of the action | +| `basket_price` | Total price of the items in the basket | +| `basket_quantity` | Total quantity of items in the basket | +| `event_action` | Type of event action (e.g., pageview, click) | +| `event_category` | Category of the event | +| `event_count` | Number of events | +| `event_custom_attributes` | Map of custom attributes associated with the event | +| `evet_duration` | Duration of the event in seconds | +| `event_label` | Label of the event | +| `event_platform` | Platform on which the event occurred (e.g., web, mobile) | +| `event_timestamp` | Timestamp when the event occurred | +| `event_url` | URL associated with the event | +| `google_client_id` | Google Analytics client ID | +| `item_category` | Category of the item | +| `item_currency` | Currency of the item price (e.g., TRY) | +| `item_custom_attributes` | Map of custom attributes associated with the item | +| `item_id` | Unique identifier for the item | +| `item_name` | Name of the item | +| `item_price` | Price of the item | +| `most_visited_category` | List of most visited categories | +| `most_visited_category_count` | Number of times the most visited categories were visited | +| `prediction` | Map of prediction probabilities for various outcomes | +| `returning_user` | Boolean indicating if the user is a returning user | +| `session_id` | Unique identifier for the session | +| `utm_campaign` | UTM campaign parameter | +| `utm_mdedium` | UTM medium parameter | +| `utm_source` | UTM source parameter | ## Adding Destinations From 61b12754fa8f130c6df66293c10e6d60d27d81ba Mon Sep 17 00:00:00 2001 From: eren-quinengine Date: Mon, 16 Sep 2024 15:56:13 +0300 Subject: [PATCH 4/5] Adjust documentation for Quin AI source integration --- .../catalog/cloud-apps/quin-ai/index.md | 20 ++++++++++--------- 1 file changed, 11 insertions(+), 9 deletions(-) diff --git a/src/connections/sources/catalog/cloud-apps/quin-ai/index.md b/src/connections/sources/catalog/cloud-apps/quin-ai/index.md index a11fa4c8e3..e01d94a8a7 100644 --- a/src/connections/sources/catalog/cloud-apps/quin-ai/index.md +++ b/src/connections/sources/catalog/cloud-apps/quin-ai/index.md @@ -1,7 +1,9 @@ +--- +title: Quin AI Source +id: WGp9SQFRVu +--- -### Quin AI Source - -Quin AI is the first deep learning, real-time behavior prediction system dedicated to e-commerce conversion optimization, for growth and profitability. +Quin AI is the first deep learning, real-time behavior prediction system dedicated to e-commerce conversion optimization for growth and profitability. 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). @@ -10,21 +12,21 @@ This source is maintained by Quin Audience Engine. For any issues with the sourc 1. From your workspace's Source page, click **Add Source**. 2. Search for "Quin AI" in the Sources Catalog, select Quin AI, and click **Add Source**. 3. On the next screen, give the Source a name configure any other settings. - - 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. SourceName_Prod, SourceName_Staging, SourceName_Dev). + - 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. QuinAI_Prod, QuinAI_Staging, QuinAI_Dev). 4. Click **Add Source** to save your settings. 5. Copy the Write key from the Segment UI. -6. Log in to your [Quin account](https://portal.quinengine.com/) and navigate to Integrations > Segment > Settings. +6. Log in to your [Quin account](https://portal.quinengine.com/){:target="_blank”} and navigate to Integrations > Segment > Settings. 7. On the Settings page, paste your Segment write key to connect. ## Stream -Quin AI uses a stream Source component to send Segment event data. It uses server-side Track and Identify methods to send data to Segment. These events are then available in any destination that accepts server-side events and available in a schema in your data warehouse that you can query using SQL. +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. -The default behavior is for Quin AI to pass the event data associated with the anonymous userId. +The default behavior is for Quin AI to pass the event data associated with the anonymousId. ## Events -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. +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. | Event Name | Description | |------------|------------------------------------| @@ -78,4 +80,4 @@ Now that your Source is set up, you can connect to Destinations. 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 there are any issues with how the events are arriving to Segment, [contact the Quin AI support team](mailto:hello@ Date: Mon, 16 Sep 2024 17:06:39 +0300 Subject: [PATCH 5/5] Adjust documentation for Quin AI source integration --- src/connections/sources/catalog/cloud-apps/quin-ai/index.md | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/src/connections/sources/catalog/cloud-apps/quin-ai/index.md b/src/connections/sources/catalog/cloud-apps/quin-ai/index.md index e01d94a8a7..3ce742eed1 100644 --- a/src/connections/sources/catalog/cloud-apps/quin-ai/index.md +++ b/src/connections/sources/catalog/cloud-apps/quin-ai/index.md @@ -12,10 +12,10 @@ This source is maintained by Quin Audience Engine. For any issues with the sourc 1. From your workspace's Source page, click **Add Source**. 2. Search for "Quin AI" in the Sources Catalog, select Quin AI, and click **Add Source**. 3. On the next screen, give the Source a name configure any other settings. - - 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. QuinAI_Prod, QuinAI_Staging, QuinAI_Dev). + - 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). 4. Click **Add Source** to save your settings. 5. Copy the Write key from the Segment UI. -6. Log in to your [Quin account](https://portal.quinengine.com/){:target="_blank”} and navigate to Integrations > Segment > Settings. +6. 6. Log in to your [Quin account](https://portal.quinengine.com/){:target="_blank”} and navigate to **Integrations > Segment > Settings**. 7. On the Settings page, paste your Segment write key to connect. ## Stream