Gainsight PX AWS S3 Integration

Overview

When you configure a connection to your S3 bucket, Gainsight PX periodically exports user, account, and event data rollups to the S3 bucket in the format (JSON, XML or CSV) you choose. For more information about S3, refer to the Amazon S3 site.

Following are the advantages of integrating Gainsight PX with S3:

• Store usage data for further processing by other services such as security logs and for future reference
• Integrate with data warehouse platforms
• Run machine-learning algorithms

Prerequisites

Ensure the following are configured to integrate PX with S3:

• AWS S3 bucket with valid credentials and write permission to the bucket.
• Time zone as per your location.PX exports data to your S3 bucket once per day for the previous day. The job starts at 3 AM  according to your subscription's timezone. The data will be available in a timeframe anywhere between a few minutes to a few hours, depending on the size of the files. For example, to create daily rollups for user events, PX sums up all events for the day based on your time zone. To set your Time Zone, navigate to Administration > Company Details > Time Zone.

Integrate S3 Export

To establish connection between Gainsight PX and S3 bucket:

1. Navigate to Administration > Integrations.
2. Click the Settings icon or Authorize button on the Amazon S3 Export widget in the Data Integrations section. The AWS S3 Settings dialog appears.

4. Select the Properties option and enter the following details to access your S3 Bucket:

• S3 Bucket Name: Bucket name and any optional sub-folder(s) separated by slashes. This is the name of the bucket that was created in S3. For Example, to export files to a bucket ABC123 with a folder “export” use ABC123/export.
• AWS Access Key and AWS Security Token credentials of your S3 bucket. Ensure you enter valid credentials to establish an S3 integration.
• Choose data type from the Export Format drop-down list
  • CSV
  • JSON
  • XML
• Choose the Export Version of the file
  •  1.0
  •  2.0 (Latest)

Note: Gainsight supports two versions of export; 1.0 and 2.0. Version 2.0 is the latest and supports environment variables and is the recommended export method. List of files, fields, and groups differ for both the versions. 

5. Get the Data Exports feature flag enabled by Support. Click the Select Reports option to view the Data Export Reports and PX Generated Reports sections. You can select the files you want to export to the AWS S3 bucket. 

Important: The data export reports will not have reports generated from the query builder.

6. Click the Summary option to view the summary of reports exported to the selected destination source.
7. Click Apply. 

8. If the credentials of your S3 bucket are valid, the status of integration changes to Authorized. Also, the Synchronize button is displayed. PX exports the data every day based on your time zone and includes data for the previous day. For more information on how to configure your time zone, refer to the Prerequisites section.
9. Click on the Synchronize button to understand the schedule for next sync.

10. Click the Disable Integration icon to disable PX integration with S3.

Export Files Definition 2.0

The list of fields and New Group by options available in Version 2.0 are as follows:

Filename	New Fields	Additions to Rollup GroupBy
GainsightPX_Account_Custom_Event_Rollups	productKey, environment	productKey, environment
GainsightPX_Account_Email_Engagement_Rollups	productKey, environment	productKey, environment
GainsightPX_Account_Event_Rollups	productKey, environment	productKey, environment
GainsightPX_Account_Feature_Match_Rollups	productKey, environment	productKey, environment
GainsightPX_Account_InApp_Event_Rollups	productKey, environment	productKey, environment
GainsightPX_Feedback_Responses	environment	environment
GainsightPX_Survey_Responses	environment, contactMeAllowed	environment
GainsightPX_User_Custom_Event_Rollups	environment	environment
GainsightPX_User_Engagement_Rollups	environment	environment
GainsightPX_User_Event_Rollups	environment	environment
GainsightPX_User_Feature_Rollups	environment	environment

Export Files Definition 1.0

Below are definitions of the output files, including field names and types. Once you receive the data from S3 bucket, use the information below to help you write and process the data. The files are compressed using gzip.

Filename Structure:
The filenames are of the form:

GainsightPX_{ExtractType}_{ISODateTime}.{json|csv|xml}.gz

Below tables give an overview about each export at its summary level.

Export Type: Account Exports

Export	Summary
Accounts	Account attributes
Account_Custom_Event_Rollups	Daily counts of custom events, grouped by day, account, event
Account_Email_Engagement_Rollups	Daily counts of email engagements, grouped by day, account, engagement, eventType
Account_Event_Rollups	Daily counts of FORM_SUBMIT, PAGE_VIEW, SEGMENT, SESSION_INITIALIZED events grouped by day, account, eventType
Account_Feature_Match_Rollups	Daily counts of feature matches, grouped by day, account, feature
Account_InApp_Event_Rollups	Daily counts of In-App engagements, grouped by day, account, engagement, eventType

Export Type: User Exports

Export	Summary
User_Custom_Event_Rollups	Daily counts of custom events grouped by day,user,productKey, account, event
User_Engagement_Rollups	Daily counts of In-App engagements grouped by day, user, propertyKey, account, engagement, eventType
User_Event_Rollups	Daily counts of FORM_SUBMIT, PAGE_VIEW, SEGMENT, SESSION_INITIALIZED events grouped by day, user, productKey, account, eventType
User_Feature_Rollups	Daily counts of feature matches grouped by day, user, propertyKey, account, feature
Users	User attributes

Export Type: Survey/Feedback Exports

Export	Summary
Survey_Responses	Surveys Response events
Feedback_Responses	Feedback events

Export Type: Metadata Exports

Export	Summary
Engagements	Engagement attributes
Features	Feature attributes

Export File Column Definitions