Skip to content

Create documentation for Quin AI source integration #6983

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 5 commits into from
Sep 17, 2024
Merged

Create documentation for Quin AI source integration #6983

Changes from 2 commits
Commits
Show all changes
5 commits
Select commit Hold shift + click to select a range
b79d805
Create documentation for Quin AI source integration
eren-quinengine Aug 27, 2024
1384e34
Adjust documentation for Quin AI source integration
eren-quinengine Aug 28, 2024
75e19dc
Adjust documentation for Quin AI source integration
eren-quinengine Sep 16, 2024
61b1275
Adjust documentation for Quin AI source integration
eren-quinengine Sep 16, 2024
033e9e4
Adjust documentation for Quin AI source integration
eren-quinengine Sep 16, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
81 changes: 81 additions & 0 deletions src/connections/sources/catalog/cloud-apps/quin-ai/index.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,81 @@

### Quin AI Source
Copy link
Contributor

@forstisabella forstisabella Aug 29, 2024 •
edited by tcgilbert
Loading

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
### Quin AI Source
---
title: Quin AI Source
id: WGp9SQFRVu
---

Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

hi - this frontmatter helps the documentation render correctly. Without it, the page will not render properly on the site.


Quin AI is the first deep learning, real-time behavior prediction system dedicated to e-commerce conversion optimization, for growth and profitability.
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
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:[email protected]).

## 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).
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
- 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.
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

We add the {:target="_blank”} attribute to ensure all links external to the segment.com/docs/ subdomain open in a new tab - this way, our mutual customers won't have to find these docs while they're halfway through setting up this source!

Suggested change
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.
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
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.
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

The term anonymousId is something that Segment refers to in the Identify Spec: https://segment.com/docs/connections/spec/identify/#anonymous-id

Suggested change
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.
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
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 |
|--------------------|------------------------------------|
| 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 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@<quinengine.com).
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
If there are any issues with how the events are arriving to Segment, [contact the Quin AI support team](mailto:hello@<quinengine.com).
If there are any issues with how the events are arriving to Segment, [contact the Quin AI support team](mailto:[email protected]).