README.md

Mixpanel

Elixir client for the Mixpanel API.

Installation

The package can be installed as:

1. Add mixpanel_api_ex to your list of dependencies in mix.exs:

def deps do
  [{:mixpanel_api_ex, "~> 2.0.0"}]
end

2. Ensure your Mixpanel token is configured in your app's config:

config :your_app, :mixpanel, token: "<Put API token here>"

3. Add YourApp.Mixpanel module to your code:

defmodule YourApp.Mixpanel do
  use Mixpanel, otp_app: :your_app
end

4. Ensure YourApp.Mixpanel is started in YourApp.Application:

def start(_type, _args) do
  children = [
    # ...
    {YourApp.Mixpanel}
  ]
end

Usage

1. Track events with Mixpanel.track/3 function:

iex> YourApp.Mixpanel.track("Signed up", %{"Referred By" => "friend"}, distinct_id: "13793")
:ok
iex> YourApp.Mixpanel.track("Level Complete", %{"Level Number" => 9}, distinct_id: "13793", time: 1358208000, ip: "203.0.113.9")
:ok

2. Track profile updates with Mixpanel.engage/4 function:

iex> YourApp.Mixpanel.engage("13793", "$set", %{"Address" => "1313 Mockingbird Lane"}, ip: "123.123.123.123")
:ok
iex> YourApp.Mixpanel.engage("13793", "$set", %{"Address" => "1313 Mockingbird Lane", "Birthday" => "1948-01-01"}, ip: "123.123.123.123")
:ok