Amplitude
Overview
Amplitude is a product analytics service that tracks user events and builds rich cross-sectional and longitudinal profiles. It primarily sources users and events from websites and mobile apps. Amplitude provides a powerful UI enabling you to create "cohorts" of users based on event histories.
Integrating Lytics with Amplitude provides cross-channel profile resolution, expedited marketing activation, and Journey Orchestration. Lytics can import the cohorts and events stored in Amplitude, enabling users to further refine targeting logic.
Authorization
If you haven't already done so, you will need to setup an Amplitude account before you begin the process described below. Follow the instructions on setting up an account and starting a new project. Each project has its own unique API key and secret, which you will need to authorize this integration.
If you are new to creating authorizations in Lytics, see the Authorizations documentation for more information.
- Select Amplitude from the list of providers.
- Select the Amplitude API Key method for authorization.
- In the Label text box, enter a name for the authorization
- (optional) In the Description text box, enter a description for this authorization
- In the API Key field, enter your Amplitude API username.
- In the API Secret field, enter your Amplitude API password.
- Click Save Authorization.
Import Cohorts
Importing cohorts from Amplitude results in new and/or updates to existing user profiles in your Lytics account containing fields from Amplitude. Once imported, Lytics can use this Amplitude data to inform its ML-based enrichments, and this data enables you to target your multi-channel campaigns orchestrated by Lytics.
Integration Details
- Implementation Type: Server-side Integration.
- Implementation Technique: REST API Integration.
- Frequency: Batch Integration one-time or daily continuous updates where the time of day can be configured.
- Resulting Data: Full user profiles from Amplitude for selected Cohorts.
This integration utilizes the Amplitude Behavioral Cohorts API to retrieve data. On each run of the job, it will request a list of cohorts, and for each cohort selected by the user during the configuration step, it will:
- Request a single cohort for download.
- Poll the request status for completion.
- Once completed, download the cohort file.
- Ingest the data from the cohort file into the Lytics data stream
amplitude_cohorts
.
Fields
The following fields are included in the default mapping of the amplitude_cohorts
stream:
Source Field | Lytics User Field | Description | Type |
---|---|---|---|
amplitude_id | amplitude_id unique id | Amplitude ID | string |
carrier | amplitude_carrier | Amplitude Carrier | string |
city | city | City | string |
country | country | Country | string |
device | amplitude_device | Amplitude Device | string |
device_type | amplitude_device_type | Amplitude Device Type | string |
dma | amplitude_dma | Amplitude DMA | string |
language | language | Language | string |
library | amplitude_library | Amplitude Library | string |
map(cohort_id, cohort_membership) | amplitude_cohort_ids | Amplitude Cohort IDs | map[string]bool |
map(cohort_name, cohort_membership) | amplitude_cohort_names | Amplitude Cohort Names | map[string]bool |
os | amplitude_os | Amplitude OS | string |
platform | amplitude_platform | Amplitude Platform | string |
region | region | State/Province | string |
region | state | State | string |
start_version | amplitude_start_version | Amplitude Start Version | string |
todate(last_computed) | amplitude_last_computed | Amplitude Cohort Last Computed time | date |
user_id | amplitude_user_id unique id | Amplitude User ID | string |
version | amplitude_version | Amplitude Version | string |
Configuration
Follow these steps to set up and configure an import job for Amplitude in the Lytics platform. If you are new to creating jobs in Lytics, see the Data Sourcesdocumentation for more information.
-
Select Amplitude from the list of providers.
-
Select the Import Cohorts job type from the list.
-
Select the Authorization you would like to use or create a new one.
-
Enter a Label to identify this job you are creating in Lytics.
-
(Optional) Enter a Description for further context on your job.
-
Complete the configuration steps for your job.
-
(Optional) From the Amplitude ID Field input, select the field name that contains the user's Amplitude ID. If left blank, cohorts will only be added to profiles.
-
(Optional) From the Amplitude Cohort Names Field input, select the field name that contains the user's cohort membership. If left blank, cohorts will only be added to profiles.
-
(Optional) From the Cohorts input, select select the cohorts you want to import. If left blank, all cohorts will be imported.
-
(Optional) Select the Keep Updated checkbox, to import cohorts daily.
-
(Optional) From the Time of Day input, select time of day to start import.
-
(Optional) From the Timezone input, select timezone for time of day.
-
Click Start Import.
Import Events
Importing events from Amplitude enables you to refine audience definitions within Lytics. Beyond just basic event triggers, Lytics can apply its ML-powered Behavioral Scores and Content Affinities to enhance user profiles.
Integration Details
- Implementation Type: Server-side Integration.
- Implementation Technique: REST API Integration.
- Frequency: Batch Integration one-time or daily continuous updates.
- Resulting Data: User Fields and Raw Event Data (see additional fields).
This integration utilizes the Amplitude Export API to retrieve event data. On each run of the job, it will:
- Request an export of zipped event data in a JSON format.
NOTE: If the user opted to backfill events, on the first run of the job it will request all events from the time frame selected by the user. Otherwise the import requests a file of all events between the current and previous run. - Ingest the data from the JSON files into the Lytics data stream
amplitude_events
.
Fields
The following fields are included in the default mapping from the amplitude_events
stream:
Source Field | Lytics User Field | Description | Type |
---|---|---|---|
$insert\_id | amplitude_insert_id | Amplitude Insert Id | string |
$schema | amplitude_schema | Amplitude Schema | int |
adid | amplitude_adid | Amplitude Adid | string |
amplitude_attribution_ids | amplitude_attribution_ids | Amplitude Amplitude Attribution IDs | string |
amplitude_event_type | amplitude_event_type | Amplitude Amplitude Event Type | string |
amplitude_id | amplitude_id unique id | Amplitude ID | string |
app | amplitude_app | Amplitude App | int |
city | city | City | string |
country | country | Country | string |
data | amplitude_data | Amplitude Data | string |
device_brand | amplitude_device_brand | Amplitude Device Brand | string |
device_carrier | amplitude_device_carrier | Amplitude Device Carrier | string |
device_family | amplitude_device_family | Amplitude Device Family | string |
device_id | amplitude_device_id | Amplitude Device ID | string |
device_manufacturer | amplitude_device_manufacturer | Amplitude Device Manufacturer | string |
device_model | amplitude_device_model | Amplitude Device Model | string |
device_type | amplitude_device_type | Amplitude Device Type | string |
dma | amplitude_dma | Amplitude Dma | string |
event_id | amplitude_event_id | Amplitude Event ID | int |
idfa | amplitude_idfa | Amplitude Idfa | string |
is_attribution_event | amplitude_is_attribution_event | Amplitude Is Attribution Event | bool |
language | language | Language | string |
library | amplitude_library | Amplitude Library | string |
location_lat | amplitude_location_lat | Amplitude Location lat | number |
location_lng | amplitude_location_lng | Amplitude Location lng | number |
match("event_properties.") | amplitude_event_properties | Amplitude Event Properties | map[string]string |
match("group_properties.") | amplitude_group_properties | Amplitude Group Properties | map[string]string |
match("user_properties.") | amplitude_user_properties | Amplitude User Properties | map[string]string |
os_name | amplitude_os_name | Amplitude OS Name | string |
os_version | amplitude_os_version | Amplitude Os Version | string |
paying | amplitude_paying | Amplitude Paying | bool |
platform | amplitude_platform | Amplitude Platform | string |
region | region | State/Province | string |
region | state | State | string |
sample_rate | amplitude_sample_rate | Amplitude Sample Rate | string |
session_id | amplitude_session_id | Amplitude Session ID | string |
todate("2006-01-02 15:04:05.000000", client_event_time) | amplitude_client_event_time | Amplitude Client Event Time | date |
todate("2006-01-02 15:04:05.000000", client_upload_time) | amplitude_client_upload_time | Amplitude Client Upload Time | date |
todate("2006-01-02 15:04:05.000000", event_time) | amplitude_event_time | Amplitude Event Time | date |
todate("2006-01-02 15:04:05.000000", server_upload_time) | amplitude_server_upload_time | Amplitude Server Upload Time | date |
todate("2006-01-02 15:04:05.000000", user_creation_time) | amplitude_user_creation_time | Amplitude User Creation Time | date |
user_id | amplitude_user_id unique id | Amplitude User ID | string |
valuect(event_type) | amplitude_events | Amplitude Event Count | map[string]intsum |
Additional fields
The following fields are not included in the default mapping, reach out to the customer support team to add them to the mappings for your account.
Source Field | Lytics User Field | Description | Type |
---|---|---|---|
server_received_time | amplitude_server_received_time | Amplitude Server Received Time | date |
processed_time | amplitude_processed_time | Amplitude Processed Time | date |
version_name | amplitude_version_name | Amplitude Version Name | string |
start_version | amplitude_start_version | Amplitude Start Version | string |
uuid | amplitude_uuid | Amplitude UUID | string |
ip_address | amplitude_ip_address | Amplitude IP Address | string |
Configuration
Follow these steps to set up and configure an import job for Amplitude in the Lytics platform. If you are new to creating jobs in Lytics, see the Data Sourcesdocumentation for more information.
- Select Amplitude from the list of providers.
- Select the Import Activity Data job type from the list.
- Select the Authorization you would like to use or create a new one.
- Enter a Label to identify this job you are creating in Lytics.
- (Optional) Enter a Description for further context on your job.
- Complete the configuration steps for your job.
- In the Backfill Days numeric field, enter how many days in the past do you want to import events (default is 90 days). Select 0 if you want to start from now on.
- (Optional) Toggle Show Advanced Options. Select the Keep Updated checkbox to import events hourly.
- Click Start Import.
Updated about 1 year ago