klaviyo

v1.0.0

klaviyo v1.0.0 Klaviyo

Elixir client for the Klaviyo REST API.

Link to this section Summary

Types

config_t()

Functions

identify(params)

Track properties of an individual without tracking an associated event

request(operation, config_overrides \\ [])

Send a request to the Klaviyo API

track(params)

Track an event

track_once(params)

Track the first occurance of an event

Link to this section Types

Link to this type config_t() 
config_t() :: [
  client: atom(),
  client_opts: any(),
  host: String.t(),
  json_codec: atom(),
  path: String.t(),
  port: pos_integer(),
  private_api_key: String.t(),
  protocol: String.t(),
  public_api_key: String.t()
]

Link to this section Functions

Link to this function identify(params) 
identify(map()) :: Klaviyo.Operation.t()

Track properties of an individual without tracking an associated event.

Link to this function request(operation, config_overrides \\ []) 
request(Klaviyo.Operation.t(), config_t()) ::
  :success | :failure | {:ok, map()} | {:error, map() | String.t()}

Send a request to the Klaviyo API.

This functions takes an optional second parameter of configuration overrides. This is useful if you want to have different configuration per request.

Link to this function track(params) 
track(map()) :: Klaviyo.Operation.t()

Track an event.

Link to this function track_once(params) 
track_once(map()) :: Klaviyo.Operation.t()

Track the first occurance of an event.