Skip to content

Commit b79d805

Browse files
eren-quinengineeren-quinengine
committed
Create documentation for Quin AI source integration
1 parent e19958d commit b79d805

File tree

1 file changed

+85
-0
lines changed
  • src/connections/sources/catalog/cloud-apps/quin-ai

1 file changed

+85
-0
lines changed

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

Lines changed: 85 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,85 @@
1+
# Quin AI Documentation
2+
3+
---
4+
Quin AI Source
5+
---
6+
7+
Quin AI is the first deep learning, real-time behaviour prediction system dedicated to e-commerce conversion optimisation, for growth and profitability.
8+
9+
This source is maintained by Quin Audience Engine. For any issues with the source, [contact their Support team](mailto:[email protected]).
10+
11+
## Getting started
12+
13+
1. From your workspace's Source page, click **Add Source**.
14+
2. Search for "Quin AI" in the Sources Catalog, select Quin AI, and click **Add Source**.
15+
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+
19+
4. Click **Add Source** to save your settings.
20+
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.
22+
23+
## Stream
24+
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.
26+
27+
The default behavior is for Quin AI to pass the event data associated with the anonymous userId.
28+
29+
## Events
30+
31+
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.
32+
33+
| Event Name | Description |
34+
|--------------------|------------------------------------|
35+
| pageview | Get an action after viewing a page |
36+
| click | Get an action after a click |
37+
38+
39+
## Event Properties
40+
41+
The table below list the properties included in the events listed above.
42+
43+
| Property Name | Description |
44+
|----------------------------|-------------------------------------------------------------|
45+
| `ActionAudienceId` | ID of the target audience for the action |
46+
| `ActionControlGroup` | Boolean indicating if the action is part of a control group |
47+
| `ActionId` | Unique identifier for the action |
48+
| `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 | |
71+
| `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 | |
77+
78+
79+
## Adding Destinations
80+
81+
Now that your Source is set up, you can connect it with Destinations.
82+
83+
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.
84+
85+
If there are any issues with how the events are arriving to Segment, [contact the Quin AI support team](mailto:hello@<quinengine.com).

0 commit comments

Comments
 (0)