Reply
This is an open group. Sign in and click the "Join Group" button to become a group member and start posting.
Highlighted
DavidW Z-Documentation Team

Z-Documentation Team

Z-Documentation Team
Posts: 34
Registered: ‎08-23-2016
[Documentation] Amplitude to Insights Connector
[ Edited ]

 

AMPLITUDE TO INSIGHTS CONNECTOR

Enables you to track your Amplitude user events in Insights.

 

HOW THE APP WORKS

The Amplitude to Insights Connector synchronizes data from your Amplitude project to your Insights stream. Every time the Amplitude to Insights Connector performs a synchronization, an Insights account or user event is created for each Amplitude user event that occurred during the past day.

 

The Amplitude to Insights Connector runs as an instance of the generic Insights Connector. You do not need to purchase the Insights Connector separately.

 

When you create an instance of the Insights Connector, you specify the following aspects of how the Amplitude to Insights Connector runs:

 

  • Which Amplitude project to retrieve data from
  • Which Insights stream to update
  • The schedule to synchronize data from Amplitude to Insights

 

INSTALLATION

 

Prerequisites

If you want the Amplitude to Insights Connector to create account events in your Insights stream, you must set a user property for each user in your Amplitude project. The user property should contain the account number of the corresponding Zuora account.

 

If you want the Amplitude to Insights Connector to create user events in your Insights stream, you must set a user property for each user in your Amplitude project. The user property must contain the user ID of the corresponding Insights user. If Insights receives an event for an unrecognized user, Insights will create a new user.

 

See the Amplitude documentation for how to set user properties in Amplitude.

 

Note: Zuora must configure a Batch API data source to receive the data that the Amplitude to Insights Connector will send to your Insights stream. To have a Batch API data source configured to receive Amplitude data, submit a request at Zuora Global Support. When you contact Zuora Global Support, include the name of the Amplitude user property that contains Zuora account numbers or Insights user IDs.

 

Zuora Global Support will process your request then provide the Batch API token for the new data source. You will need the Batch API token when you install the Amplitude to Insights Connector.

 

Install the App

Use the following steps to install the Amplitude to Insights connector:

 

  1. Purchase the Amplitude to Insights Connector in the Connect Marketplace.

     

    To find out whether your organization's purchase of Insights includes connector apps at no additional cost, contact your Zuora representative.

     

  2. Create a Zuora Connect login for Insights.

     

    The Zuora Connect login enables the Amplitude to Insights Connector to authenticate to Insights via the Batch API. It is recommended to name the Zuora Connect login "Insights Batch API target for Amplitude connector."

     

    You need to create a Zuora Connect login even if you have previously created a Zuora Connect login that specifies Batch API credentials for your Insights stream. This is because each Batch API token is generated specifically for a particular external system, and cannot be used to send data to Insights from a different external system.

     

  3. Create a Zuora Connect login for Amplitude.

     

    The Zuora Connect login enables the Amplitude to Insights Connector to authenticate to Amplitude.

     

    To complete this step, you will need the API Key and Secret Key for your Amplitude project. The API Key and Secret Key are listed in your Amplitude project's settings area. See Project General Settings in the Amplitude documentation for more information.

     

  4. Create an instance of the Insights Connector (see below).

 

After you have installed the Amplitude to Insights Connector, you can monitor the synchronizations that the Amplitude to Insights Connector performs.

 

Create an Instance of the Insights Connector

The Amplitude to Insights Connector runs as an instance of the generic Insights Connector.

 

To create an instance of the Insights Connector:

 

  1. In Zuora Connect, navigate to My Connect > Tenants.

     

    The Tenant Logins page opens.

     

  2. Locate the Zuora Connect login that you created for the Insights Batch API, then hover and click Apps:

     

     

    The Insights Connector page opens.

     

  3. Click New.

     

    The "Insights Connector - New Configuration" dialog box opens.

     

  4. Enter the following information in the "Insights Connector - New Configuration" dialog box:

     

    • Name - The name that you will use to identify the instance in Zuora Connect
    • Run Mode - Amplitude
    • Execution - Scheduled
      If you select External instead of Scheduled, the Amplitude to Insights Connector will only synchronize data when you initiate a synchronization. You can initiate a synchronization by clicking Sync on Demand in the Amplitude to Insights Connector, or via the API that the Insights Connector provides.
    • Source - The Zuora Connect login that you created for Amplitude
    • Target - The Zuora Connect login that you created for the Insights Batch API

     

    For example:

     

     

  5. Select the Schedule tab.

     

  6. Use the Timezone field and the schedule builder to set how frequently to synchronize data.

     

    It is recommended to set a daily schedule. To ensure that Insights displays the latest Amplitude data as soon as possible, it is recommended to set synchronization to take place shortly before all Insights batch uploads start processing. See Insights Batch API for more information about batch uploads.

     

    The Interval field displays the specified schedule as a CRON expression.

     

  7. Click Create.

 

Zuora Connect creates an instance of the Insights Connector. The Amplitude to Insights Connector is now running.

 

You can use the menu to manage the instance. If you stop the instance, the Amplitude to Insights Connector will stop running and no data will be synchronized. You cannot restart a stopped instance, but you can start a new instance with the same configuration by cloning the instance.

 

MONITOR THE APP

The Amplitude to Insights Connector lists the synchronizations that have been performed.

 

To open the Amplitude to Insights Connector, locate the instance of the Insights Connector that you created, then select Launch from the menu. To immediately initiate a synchronization click Sync on Demand.

 

For completed synchronizations, you can download a JSON description of the data that was synchronized from Amplitude to Insights. These JSON descriptions are currently retained indefinitely.

 

If a synchronization starts but does not complete, the Amplitude to Insights Connector will retry the synchronization up to 25 times.

 

If the status of a synchronization is Error, submit a request at Zuora Global Support.

 

SUPPORT AND FAQS

Ask questions and connect with users just like you here in the Community:

 

  • Have a question? Get answers to your questions from other app users and our subject matter experts.
  • Found a bug? Let us know! Add "[BUG]" in the subject line and our team will look into it.
  • Got feedback? Share your ideas at Connect Ideas and Insights Ideas to help us make this app better.

 

See the Zuora Knowledge Center for information related to this app: