MixpanelDataClient
SourceSummary↑
delete!(url, headers \\ [], options \\ []) | Issues a DELETE request to the given url, raising an exception in case of failure |
delete(url, headers \\ [], options \\ []) | Issues a DELETE request to the given url |
encode_pair(arg1) | |
expire(base \\ epoch(), future \\ 60) | |
fetch(endpoint, params, arg3) | Fetch data from the mixpanel data api |
get!(url, headers \\ [], options \\ []) | Issues a GET request to the given url, raising an exception in case of failure |
get(url, headers \\ [], options \\ []) | Issues a GET request to the given url |
head!(url, headers \\ [], options \\ []) | Issues a HEAD request to the given url, raising an exception in case of failure |
head(url, headers \\ [], options \\ []) | Issues a HEAD request to the given url |
md5(s) | |
mixpanel_uri(endpoint, query, key, secret, expire) | |
options!(url, headers \\ [], options \\ []) | Issues a OPTIONS request to the given url, raising an exception in case of failure |
options(url, headers \\ [], options \\ []) | Issues an OPTIONS request to the given url |
patch!(url, body, headers \\ [], options \\ []) | Issues a PATCH request to the given url, raising an exception in case of failure |
patch(url, body, headers \\ [], options \\ []) | Issues a PATCH request to the given url |
post!(url, body, headers \\ [], options \\ []) | Issues a POST request to the given url, raising an exception in case of failure |
post(url, body, headers \\ [], options \\ []) | Issues a POST request to the given url |
put!(url, body, headers \\ [], options \\ []) | Issues a PUT request to the given url, raising an exception in case of failure |
put(url, body, headers \\ [], options \\ []) | Issues a PUT request to the given url |
request!(method, url, body \\ "", headers \\ [], options \\ []) | Issues an HTTP request with the given method to the given url, raising an exception in case of failure |
request(method, url, body \\ "", headers \\ [], options \\ []) | Issues an HTTP request with the given method to the given url |
signature(query_params, key, secret, expire) | |
start() | Starts HTTPoison and its dependencies |
Types ↑
headers :: %{} | [{binary, binary}]
Functions
Specs:
- delete(binary, headers, [{atom, any}]) :: {:ok, HTTPoison.Response.t | HTTPoison.AsyncResponse.t} | {:error, HTTPoison.Error.t}
Issues a DELETE request to the given url.
Returns {:ok, response}
if the request is successful, {:error, reason}
otherwise.
See request/5
for more detailed information.
Specs:
- delete!(binary, headers, [{atom, any}]) :: HTTPoison.Response.t | HTTPoison.AsyncResponse.t
Issues a DELETE request to the given url, raising an exception in case of failure.
If the request does not fail, the response is returned.
See request!/5
for more detailed information.
Specs:
Fetch data from the mixpanel data api.
Pass in an method, your query paramters, and then your key and secret and it will fetch the data returning a map.
* Method: As defined [here](https://mixpanel.com/docs/api-documentation/data-export-api#)
For example, if you wanted to use the segmentation method you'd pass in "segementation".
If you wanted to use the annotations create method you'd use "annotations/create"
* Params: Following the spec, pass a map of query paramters you'd like to use.
* Auth Tuple: `{key, secret}` using a tuple pass in the key and screet as found in the account settings.
Example ```elixir
MixpanelDataClient.fetch("segmentation", %{"event" => "signed_up", "from_date" => "2011-08-07",
"to_date" => "2011-08-09"}, {"key", "secret_key"})
=> %{"data" => %{...}}
```
Specs:
- get(binary, headers, [{atom, any}]) :: {:ok, HTTPoison.Response.t | HTTPoison.AsyncResponse.t} | {:error, HTTPoison.Error.t}
Issues a GET request to the given url.
Returns {:ok, response}
if the request is successful, {:error, reason}
otherwise.
See request/5
for more detailed information.
Specs:
- get!(binary, headers, [{atom, any}]) :: HTTPoison.Response.t | HTTPoison.AsyncResponse.t
Issues a GET request to the given url, raising an exception in case of failure.
If the request does not fail, the response is returned.
See request!/5
for more detailed information.
Specs:
- head(binary, headers, [{atom, any}]) :: {:ok, HTTPoison.Response.t | HTTPoison.AsyncResponse.t} | {:error, HTTPoison.Error.t}
Issues a HEAD request to the given url.
Returns {:ok, response}
if the request is successful, {:error, reason}
otherwise.
See request/5
for more detailed information.
Specs:
- head!(binary, headers, [{atom, any}]) :: HTTPoison.Response.t | HTTPoison.AsyncResponse.t
Issues a HEAD request to the given url, raising an exception in case of failure.
If the request does not fail, the response is returned.
See request!/5
for more detailed information.
Specs:
- options(binary, headers, [{atom, any}]) :: {:ok, HTTPoison.Response.t | HTTPoison.AsyncResponse.t} | {:error, HTTPoison.Error.t}
Issues an OPTIONS request to the given url.
Returns {:ok, response}
if the request is successful, {:error, reason}
otherwise.
See request/5
for more detailed information.
Specs:
- options!(binary, headers, [{atom, any}]) :: HTTPoison.Response.t | HTTPoison.AsyncResponse.t
Issues a OPTIONS request to the given url, raising an exception in case of failure.
If the request does not fail, the response is returned.
See request!/5
for more detailed information.
Specs:
- patch(binary, binary, headers, [{atom, any}]) :: {:ok, HTTPoison.Response.t | HTTPoison.AsyncResponse.t} | {:error, HTTPoison.Error.t}
Issues a PATCH request to the given url.
Returns {:ok, response}
if the request is successful, {:error, reason}
otherwise.
See request/5
for more detailed information.
Specs:
- patch!(binary, binary, headers, [{atom, any}]) :: HTTPoison.Response.t | HTTPoison.AsyncResponse.t
Issues a PATCH request to the given url, raising an exception in case of failure.
If the request does not fail, the response is returned.
See request!/5
for more detailed information.
Specs:
- post(binary, binary, headers, [{atom, any}]) :: {:ok, HTTPoison.Response.t | HTTPoison.AsyncResponse.t} | {:error, HTTPoison.Error.t}
Issues a POST request to the given url.
Returns {:ok, response}
if the request is successful, {:error, reason}
otherwise.
See request/5
for more detailed information.
Specs:
- post!(binary, binary, headers, [{atom, any}]) :: HTTPoison.Response.t | HTTPoison.AsyncResponse.t
Issues a POST request to the given url, raising an exception in case of failure.
If the request does not fail, the response is returned.
See request!/5
for more detailed information.
Specs:
- put(binary, binary, headers, [{atom, any}]) :: {:ok, HTTPoison.Response.t | HTTPoison.AsyncResponse.t} | {:error, HTTPoison.Error.t}
Issues a PUT request to the given url.
Returns {:ok, response}
if the request is successful, {:error, reason}
otherwise.
See request/5
for more detailed information.
Specs:
- put!(binary, binary, headers, [{atom, any}]) :: HTTPoison.Response.t | HTTPoison.AsyncResponse.t
Issues a PUT request to the given url, raising an exception in case of failure.
If the request does not fail, the response is returned.
See request!/5
for more detailed information.
Specs:
- request(atom, binary, binary, headers, [{atom, any}]) :: {:ok, HTTPoison.Response.t | HTTPoison.AsyncResponse.t} | {:error, HTTPoison.Error.t}
Issues an HTTP request with the given method to the given url.
Args:
method
- HTTP method as an atom (:get
,:head
,:post
,:put
,:delete
, etc.)url
- target url as a binary string or char listbody
- request body as a binary string or char listheaders
- HTTP headers as an orddict (e.g., `[{:Accept, "application/json"}]`)options
- orddict of options
Options:
:timeout
- the timeout (in milliseconds) of the request:stream_to
- a PID to stream the response to:proxy
- a proxy to be used for the request; it can by a regular url or a{Host, Proxy}
tuple
This function returns {:ok, response}
or {:ok, async_response}
if the
request is successful, {:error, reason}
otherwise.
Examples
request(:post, "https://my.website.com", "{\"foo\": 3}", [{"Accept", "application/json"}])
Specs:
- request!(atom, binary, binary, headers, [{atom, any}]) :: HTTPoison.Response.t
Issues an HTTP request with the given method to the given url, raising an exception in case of failure.
request!/5
works exactly like request/5
but it returns just the
response in case of a successful request, raising an exception in case the
request fails.
Starts HTTPoison and its dependencies.