Class: Warbler::ActivitiesController

Inherits:
ApplicationController show all
Defined in:
lib/warbler/controllers/activities_controller.rb

Instance Method Summary collapse

Methods inherited from ApplicationController

#initialize

Constructor Details

This class inherits a constructor from Warbler::ApplicationController

Instance Method Details

#track(activity_type, record_id: nil) ⇒ Object

This endpoint lets you track the actions your users perform.

Parameters:

  • activity_type (String) —

    Required parameter: The type of activity the user is performing. Example: ‘purchased-a-product’

  • record_id (String) (defaults to: nil) —

    Optional parameter: The ID for the record associated with the activity in your database.

Returns:

  • mixed response from the API call



10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
 
# File 'lib/warbler/controllers/activities_controller.rb', line 10

def track activity_type, record_id: nil
  # the base uri for api requests
  query_builder = base_uri

  # prepare query string for API call
  query_builder << "/v3/activities"

  # process optional query parameters
  query_builder = APIHelper.append_url_with_query_parameters query_builder, {
    "activity_type" => activity_type,
    "record_id" => record_id,
  }

  perform_query('post', query_builder)
end