Authenticate with Mixpanel

You can authenticate with Mixpanel to create your own instance of the Mixpanel element through the UI or through APIs. Once authenticated, you can use the element instance to access the different functionality offered by the Mixpanel platform.

Authenticate Through the UI

Use the UI to authenticate with Mixpanel and create an element instance. You will need your API Secret that you identified in API Provider Setup.

To authenticate an element instance:

  1. Sign in to Cloud Elements, and then search for Mixpanel in our Elements Catalog. Search
  2. Hover over the element card, and then click Authenticate. Create Instance
  3. Enter a name for the element instance.
  4. In API Secret enter the credentials that you identified in API Provider Setup.
  5. Optionally type or select one or more Element Instance Tags to add to the authenticated element instance.
  6. Click Authenticate.

After successfully authenticating, we give you several options for next steps with the authenticated element instance. Make requests using the API docs associated with the instance, map the instance to a virtual data resource, or use it in a formula template.

Authenticate Through API

Authenticating through API is similar to authenticating via the UI. Instead of clicking and typing through a series of buttons, text boxes, and menus, you will instead send a request to our /instances endpoint. The end result is the same, though: an authenticated element instance with a token and id.

To authenticate an element instance:

  1. Construct a JSON body as shown below (see Parameters):

    {
      "element": {
        "key": "mixpanel"
      },
      "configuration": {
        "username": "<Mixpanel API Secret>"
      },
      "tags": [
        "<Add_Your_Tag>"
      ],
      "name": "<INSTANCE_NAME>"
    }
    
  2. Call the following, including the JSON body you constructed in the previous step:

    POST /instances
    
  3. Locate the token and id in the response and save them for all future requests using the element instance.

Example cURL

curl -X POST \
  https://api.cloud-elements.com/elements/api-v2/instances \
  -H 'authorization: User <USER_SECRET>, Organization <ORGANIZATION_SECRET>' \
  -H 'content-type: application/json' \
  -d '{
  "element": {
    "key": "mixpanel"
  },
  "configuration": {
    "username": "xxxxxxxxxxxxxxxxxx"
  },
  "tags": [
    "Docs"
  ],
  "name": "API Instance"
}'

Parameters

API parameters not shown in Cloud Elements are in code formatting.

Parameter Description Data Type
key The element key.
mixpanel
string
Name
name
The name of the element instance created during authentication. string
API Secret
username
The Mixpanel API Secret that you noted in API Provider Setup. string
tags Optional. User-defined tags to further identify the instance. string

Example Response for an Authenticated Element Instance

In this example, the instance ID is 12345 and the instance token starts with "ABC/D...". The actual values returned to you will be unique: make sure you save them for future requests to this new instance.

{
  "id": 12345,
  "name": "API Instance",
  "createdDate": "2017-08-07T18:46:38Z",
  "token": "ABC/Dxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx",
  "element": {
      "id": 13973,
      "name": "Mixpanel",
      "key": "mixpanel",
      "description": "Add an Mixpanel element to connect to your existing mixpanel account, allowing you to create activities, users and download activities and users",
      "image": "https://uxcam.com/images/mixpanel-logo.png",
      "active": true,
      "deleted": false,
      "typeOauth": false,
      "trialAccount": false,
      "resources": [ ],
      "transformationsEnabled": true,
      "bulkDownloadEnabled": true,
      "bulkUploadEnabled": false,
      "cloneable": true,
      "extendable": false,
      "beta": false,
      "authentication": {
          "type": "basic"
      },
      "extended": false,
      "hub": "general",
      "protocolType": "http",
      "parameters": [  ],
      "private": false
    },
    "elementId": 13973,
    "tags": [
        "Docs"
    ],
    "provisionInteractions": [],
    "valid": true,
    "disabled": false,
    "maxCacheSize": 0,
    "cacheTimeToLive": 0,
    "configuration": {    },
    "eventsEnabled": false,
    "traceLoggingEnabled": false,
    "cachingEnabled": false,
    "externalAuthentication": "none",
    "user": {
        "id": 12345
      }
}