Skip to main content

Amplitude

Integrating Amplitude with Osano​

Connecting to Amplitude​

In order for Osano to discover data stored in your systems, we must connect to those data providers via an API. We require, at minimum, read-only access to establish a connection to these providers. Each provider you connect may require different information. Please see the linked vendor documentation for instructions on where and how to obtain this data.

Required Fields​

  • API Key
  • API Secret

Instructions for obtaining your Amplitude API Key.

Core Functionality​

  • Data Discovery
  • User Search
  • Data Deletion
  • User search will only work if emails are user ids within Amplitude, otherwise, it will not display any results.

Auth​

  • Token Based

Endpoints​

Used for data discovery

  • GET https://amplitude.com/api/2/usersearch?user={{email}}
  • GET https://profile-api.amplitude.com/v1/userprofile?user_id={{userId}}&get_cohort_ids=true
  • GET https://profile-api.amplitude.com/v1/userprofile?user_id={{userId}}&get_amp_props=true
  • GET https://profile-api.amplitude.com/v1/userprofile?user_id={{userId}}&get_recs=true
  • GET https://profile-api.amplitude.com/v1/userprofile?user_id={{userId}}&get_computations=true

Used for user search

  • GET https://amplitude.com/api/2/usersearch?user={{email}}
  • GET https://profile-api.amplitude.com/v1/userprofile?user_id={{userId}}&get_recs=true
  • GET https://profile-api.amplitude.com/v1/userprofile?user_id={{userId}}&get_amp_props=true
  • GET https://profile-api.amplitude.com/v1/userprofile?user_id={{userId}}&get_cohort_ids=true
  • GET https://profile-api.amplitude.com/v1/userprofile?user_id={{userId}}&get_computations=true

Used for data deletion

  • POST https://amplitude.com/api/2/deletions/users

Notes on automated deletion requests​

  • Within an action item created for Amplitude, in order to select automated API call deletion, please input the user ID field by clicking the EDIT button next to the search term.

Segment edit user ID

  • The user id is the amplitude id for the user. This is the amplitude id that is assigned to the user when they are created in Amplitude.

  • Amplitude usually processes deletion requests within 30 days of receiving the request.