Skip to content

Commit 1384e34

Browse files
eren-quinengineeren-quinengine
committed
Adjust documentation for Quin AI source integration
1 parent b79d805 commit 1384e34

File tree

1 file changed

+35
-39
lines changed
  • src/connections/sources/catalog/cloud-apps/quin-ai

1 file changed

+35
-39
lines changed

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

Lines changed: 35 additions & 39 deletions
Original file line numberDiff line numberDiff line change
@@ -1,28 +1,24 @@
1-
# Quin AI Documentation
21

3-
---
4-
Quin AI Source
5-
---
2+
### Quin AI Source
63

7-
Quin AI is the first deep learning, real-time behaviour prediction system dedicated to e-commerce conversion optimisation, for growth and profitability.
4+
Quin AI is the first deep learning, real-time behavior prediction system dedicated to e-commerce conversion optimization, for growth and profitability.
85

9-
This source is maintained by Quin Audience Engine. For any issues with the source, [contact their Support team](mailto:[email protected]).
6+
This source is maintained by Quin Audience Engine. For any issues with the source, [contact the Quin Audience Engine Support team](mailto:[email protected]).
107

118
## Getting started
129

1310
1. From your workspace's Source page, click **Add Source**.
1411
2. Search for "Quin AI" in the Sources Catalog, select Quin AI, and click **Add Source**.
1512
3. On the next screen, give the Source a name configure any other settings.
16-
17-
- 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).
18-
13+
- 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).
1914
4. Click **Add Source** to save your settings.
2015
5. Copy the Write key from the Segment UI.
21-
6. Log in to your [Quin account](https://portal.quinengine.com/) - navigate to Integrations > Segment > Settings and paste the write key to connect.
16+
6. Log in to your [Quin account](https://portal.quinengine.com/) and navigate to Integrations > Segment > Settings.
17+
7. On the Settings page, paste your Segment write key to connect.
2218

2319
## Stream
2420

25-
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.
21+
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.
2622

2723
The default behavior is for Quin AI to pass the event data associated with the anonymous userId.
2824

@@ -46,39 +42,39 @@ The table below list the properties included in the events listed above.
4642
| `ActionControlGroup` | Boolean indicating if the action is part of a control group |
4743
| `ActionId` | Unique identifier for the action |
4844
| `ActionIsCustom` | Boolean indicating if the action is custom |
49-
| `ActionName` | Name of the action | | |
50-
| `ActionType` | Type of the action | | |
51-
| `BasketPrice` | Total price of the items in the basket | | |
52-
| `BasketQuantity` | Total quantity of items in the basket | | |
53-
| `EventAction` | Type of event action (e.g., pageview, click) | | |
54-
| `EventCategory` | Category of the event | | | | |
55-
| `EventCount` | Number of events | | | | |
56-
| `EventCustomAttributes` | Map of custom attributes associated with the event | | | | |
57-
| `EventDuration` | Duration of the event in seconds | | | | |
58-
| `EventLabel` | Label of the event | | | | |
59-
| `EventPlatform` | Platform on which the event occurred (e.g., web, mobile) | | | | |
60-
| `EventTimestamp` | Timestamp when the event occurred | | | | |
61-
| `EventURL` | URL associated with the event | | | | |
62-
| `GoogleClientId` | Google Analytics client ID | | | | |
63-
| `ItemCategory` | Category of the item | |
64-
| `ItemCurrency` | Currency of the item price (e.g., TRY) | |
65-
| `ItemCustomAttributes` | Map of custom attributes associated with the item | |
66-
| `ItemId` | Unique identifier for the item | |
67-
| `ItemName` | Name of the item | |
68-
| `ItemPrice` | Price of the item | |
69-
| `MostVisitedCategory` | List of most visited categories | |
70-
| `MostVisitedCategoryCount` | Number of times the most visited categories were visited | |
45+
| `ActionName` | Name of the action |
46+
| `ActionType` | Type of the action |
47+
| `BasketPrice` | Total price of the items in the basket |
48+
| `BasketQuantity` | Total quantity of items in the basket |
49+
| `EventAction` | Type of event action (e.g., pageview, click) |
50+
| `EventCategory` | Category of the event |
51+
| `EventCount` | Number of events |
52+
| `EventCustomAttributes` | Map of custom attributes associated with the event |
53+
| `EventDuration` | Duration of the event in seconds |
54+
| `EventLabel` | Label of the event |
55+
| `EventPlatform` | Platform on which the event occurred (e.g., web, mobile) |
56+
| `EventTimestamp` | Timestamp when the event occurred |
57+
| `EventURL` | URL associated with the event |
58+
| `GoogleClientId` | Google Analytics client ID |
59+
| `ItemCategory` | Category of the item |
60+
| `ItemCurrency` | Currency of the item price (e.g., TRY) |
61+
| `ItemCustomAttributes` | Map of custom attributes associated with the item |
62+
| `ItemId` | Unique identifier for the item |
63+
| `ItemName` | Name of the item |
64+
| `ItemPrice` | Price of the item |
65+
| `MostVisitedCategory` | List of most visited categories |
66+
| `MostVisitedCategoryCount` | Number of times the most visited categories were visited |
7167
| `Prediction` | Map of prediction probabilities for various outcomes |
72-
| `ReturningUser` | Boolean indicating if the user is a returning user | |
73-
| `SessionId` | Unique identifier for the session | |
74-
| `UTMCampaign` | UTM campaign parameter | |
75-
| `UTMMedium` | UTM medium parameter | |
76-
| `UTMSource` | UTM source parameter | |
68+
| `ReturningUser` | Boolean indicating if the user is a returning user |
69+
| `SessionId` | Unique identifier for the session |
70+
| `UTMCampaign` | UTM campaign parameter |
71+
| `UTMMedium` | UTM medium parameter |
72+
| `UTMSource` | UTM source parameter |
7773

7874

7975
## Adding Destinations
8076

81-
Now that your Source is set up, you can connect it with Destinations.
77+
Now that your Source is set up, you can connect to Destinations.
8278

8379
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.
8480

0 commit comments

Comments
 (0)