How to ingest and view usage events in ClientSuccess

Our product usage tracking feature allows you to observe key actions that your clients do within your app. These events can be nearly anything, including buttons clicked, pages viewed, time spent completing actions, projects completed, or dollars processed.

The right metric is whatever best indicates that your user is engaged and getting value out of your app. Once passed to ClientSuccess, you'll be able to compare usage trends over several predefined time periods as a daily average or total.

Please Note - It's a common practice to include these usage metrics and trends as a part of your overall SuccessScore.

You can track up to 20 events that would include up to 1 million events a month.

There are four options to pass usage data into ClientSuccess:

• Directly from the API - Submit events to the ClientSuccess Usage API. This is best for lower-level, complex events, calculated, or batched data.
  • When passing through emails via the API, we strongly recommend passing them through as lower-case strings.
• Configured Flat file - Follow these instructions to import CSV. We support ad-hoc and scheduled imports of usage data via the following methods:
  • S3
  • Google Cloud Files
  • SFTP 
• Through the Browser - Add the ClientSuccess javascript snippet to your app. This is best for tracking high-level events that occur in the interface.
  • When passing through emails via javascript, we strongly recommend passing them through as lower-case strings.
• Via Pendo - Send usage data in via our Pendo Integration.
• Via Segment - Send usage data in via our Segment Integration.

You can use any combination of these methods to push different types of usage metrics into the Usage App tracker in ClientSuccess.

What information does ClientSuccess usage tracking provide?

• Average events within the selected time period
• Total events within the selected time period
• Trending visualization of events within the selected time period
• Trending visualization of events within the previous time period
• Available time periods:
  • Today
  • Yesterday
  • Last week
  • Last month
  • Last 7 days
  • Last 30 days
  • Last 60 days
  • Last 90 days
  • Last 180 days

To install product usage tracking, you must:

• Be an Admin user with full access to ClientSuccess.

API usage event efficiency planning

The standard limit for the number of events sent through the ClientSuccess Usage API is 1mm/month.  If need to increase that, please contact your CSM.  There is an additional fee for increased usage events.

There are two options to help you optimize the # of events you send through the API.

1. Pre-aggregate the # of events for the desired period BEFORE submitting to ClientSuccess.  

Example:  If Jimmy logs in 3 times on August 19th, instead of sending three events each with a 'value' of 1, send one event with a value of 3 for the day.

2. Send Client-level events vs Contact-level events.   If you are not concerned about comparing the number of events between each individual user, and are only interested in tracking the number of events per Client, simply aggregate all usage events to the Client level before sending to ClientSuccess.

Getting Started

Method 1 - Direct integration via API:

1. Locate your Usage API Key and Project ID on the Usage Settings screen.

2. Click on this link to get the API details to configure the usage API with your API - ClientSuccess Usage API 

Method 2 - Automated Flat File ingestion

1. Follow these instructions to automate a regular import of your usage data via CSV.

Method 3 - Through the Browser

1. Click on this link to find instructions for adding the ClientSuccess javascript snippet to your app. This is best for tracking high-level events that occur in the interface.

Method 4 - Via Pendo

1. Click on this link to follow instructions for a Pendo Integration.

Method 5 - Via Segment

1. Click on this link to send usage data in via our Segment Integration.

3. From your Usage Settings page, set a "Primary Metric", "Default Date Range" and "Default Metric":

4. If the organization name passed in matches a Client name in ClientSuccess, then the ID will be associated with that client automatically when the first event is passed in. If the organization name doesn't match a Client name exactly, then you will need to perform a one-time, manual pairing after the first event is passed in as shown in the image below.  You will need to click on the drop-down arrow and select the correct client that usage data should be paired with and hit "save". Once the organization ID is associated with a Client, all future events will be automatically associated with that Client by the organization ID.

Note:  Data must be actively sent into ClientSuccess before the Usage App window will show up in the interface. 

Updating your terms of use and privacy policy

We suggest that you include the following section to account for using ClientSuccess on your website or web application. Always review changes to your sites terms & privacy policy with your lawyers.

Use of ClientSuccess Services: We use third-party analytics services to help understand your usage of our services. In particular, we provide a limited amount of your information (such as your name, email address, and timestamps) to ClientSuccess, LLC (“ClientSuccess”) to collect data for analytics purposes when you visit our website or use our product. ClientSuccess analyzes your use of our website and/or product and tracks our relationship so that we can improve our service to you. We may also use ClientSuccess as a medium for communications, either through email, or through messages within our product(s). As part of our service agreements, ClientSuccess collects publicly available contact and social information related to you, such as your email address, gender, company, job title, photos, website URLs, social network handles and physical addresses, to enhance your user experience. For more information on the privacy practices of ClientSuccess, please visit http://www.clientsuccess.com/privacy-policy. ClientSuccess' services are governed by ClientSuccess' terms of use which can be found at http://www.clientsuccess.com/terms. If you would like to opt out of having this information collected by or submitted to ClientSuccess, please contact us.