active_campaign v0.3.0

View Source ActiveCampaign.Tracking.Event (active_campaign v0.3.0)

Documentation for ActiveCampaign.Tracking.Event.

Link to this section Summary

Functions

create(name)

Create a new event (name only)

delete(name)

Delete event (name only)

get_contact_by_event_id(event_id)

Get Contact By Event ID

get_contact_tracking(contact_id)

Get Contact's Tracking Logs/Events

get_status()

Retrieve Event Tracking Status

list(query_params \\ %{})

List all events (names only)

set_enabled(bool)

Enable/disable

track(event, eventdata, visit)

Track event

Link to this section Functions

Link to this function

create(name)

View Source 
@spec create(String.t()) :: {:ok, map()} | {:error, any()}

Create a new event (name only)

Link to this function

delete(name)

View Source 
@spec delete(String.t()) :: {:ok, map()} | {:error, any()}

Delete event (name only)

Spaces in the name should be left as spaces, they will automatically be encoded.

Link to this function

get_contact_by_event_id(event_id)

View Source 
@spec get_contact_by_event_id(integer()) :: {:ok, map()} | {:error, any()}

Get Contact By Event ID

Link to this function

get_contact_tracking(contact_id)

View Source 
@spec get_contact_tracking(integer()) :: {:ok, map()} | {:error, any()}

Get Contact's Tracking Logs/Events

Link to this function

get_status()

View Source 
@spec get_status() :: {:ok, map()} | {:error, any()}

Retrieve Event Tracking Status

Link to this function

list(query_params \\ %{})

View Source 
@spec list(map()) :: {:ok, map()} | {:error, any()}

List all events (names only)

Link to this function

set_enabled(bool)

View Source 
@spec set_enabled(boolean()) :: {:ok, map()} | {:error, any()}

Enable/disable

Link to this function

track(event, eventdata, visit)

View Source 
@spec track(String.t(), String.t(), map()) :: {:ok, map()} | {:error, any()}

Track event