Skip to content
This repository has been archived by the owner on Sep 22, 2023. It is now read-only.

Create profile-properties.md #794

Merged
merged 3 commits into from
Sep 19, 2023
Merged
Changes from 2 commits
Commits
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
53 changes: 53 additions & 0 deletions docs/data/profile-properties.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,53 @@
---
title: Profile Properties
description: Profile Properties allow you to sync a current property value from a source (currently only Snowflake) to use within the Amplitude platform.
---

## Context
markzegarelli marked this conversation as resolved.
Show resolved Hide resolved
Customers can now bring in non-behavioral, customer profile data from their data warehouse to merge it with the existing behavioral product data already living in Amplitude. These values will always display the most current value being synced from the customer’s data warehouse.
markzegarelli marked this conversation as resolved.
Show resolved Hide resolved

## Setup
markzegarelli marked this conversation as resolved.
Show resolved Hide resolved
To set up a Profile Property in Amplitude, you must connect Amplitude to your data warehouse. Once connected, and you reach the data configuration section, you must select the “Warehouse Props” data type in the dropdown. From there, there are two minimum requirements for the import: a user identifier (user_id) and a profile property. Note: you may add more than one warehouse property per import, but there must be at least one per import.
Copy link
Contributor

Choose a reason for hiding this comment

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

Need some additional context here, and we should format this in an ordered list.


## Data Specifications
markzegarelli marked this conversation as resolved.
Show resolved Hide resolved
The maximum number of warehouse properties currently supported for a single profile property import is 200. Today, profile properties are only supported for known Amplitude users. Therefore, each profile property must be accompanied by a user identifier (user_id).
markzegarelli marked this conversation as resolved.
Show resolved Hide resolved

| Field | Description | Example |
| ------------------- | ----------------------------------------------------------------------------------------------------------------------------- | ------------------------ |
| User ID | Identifier for the user. Must have a minimum length of 5. | [email protected] |
| Profile Property 1 | Profile property set at the user-level. The value of this field will be the value from the customer’s source since last sync. | “Title”: “Data Engineer” |
markzegarelli marked this conversation as resolved.
Show resolved Hide resolved
| Profile Property 2… | Profile property set at the user-level. The value of this field will be the value from the customer’s source since last sync. | “City”: “San Francisco” |
markzegarelli marked this conversation as resolved.
Show resolved Hide resolved

## SQL Template
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
## SQL Template
## SQL template

markzegarelli marked this conversation as resolved.
Show resolved Hide resolved

```
markzegarelli marked this conversation as resolved.
Show resolved Hide resolved
SELECT
__________ AS "user_id",
__________ AS "profile_property_1",
__________ AS "profile_property_2"
FROM DATABASE_NAME.SCHEMA_NAME.TABLE_OR_VIEW_NAME
```

## Clearing a Profile Property Value
markzegarelli marked this conversation as resolved.
Show resolved Hide resolved
Sometimes customers want to remove the value associated with a user in Amplitude. Because Amplitude performs a “full sync” with the customer’s data warehouse, all that is needed is for the customer to update the underlying value in the table with an empty value. This will zero out the value in Amplitude during the subsequent sync. Customers can use Amplitude Data to fully remove unused property fields from users in Amplitude.
markzegarelli marked this conversation as resolved.
Show resolved Hide resolved

## Sample Queries
markzegarelli marked this conversation as resolved.
Show resolved Hide resolved

```
markzegarelli marked this conversation as resolved.
Show resolved Hide resolved
SELECT
user_id as "user_id",
upgrade_propensity_score as "Upgrade Propensity Score",
user_model_version as "User Model Version"
FROM
ml_models.prod_propensity_scoring
```

```
markzegarelli marked this conversation as resolved.
Show resolved Hide resolved
SELECT
m.uid as "user_id",
m.title as "Title",
m.seniority as "Seniority",
m.dma as "DMA"
FROM
prod_users.demo_data m
```