|
| 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:[email protected]). |
| 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:[email protected]). |
0 commit comments