RakamClient - the Ruby gem for the Rakam API Documentation

An analytics platform API that lets you create your own analytics services.

This SDK is automatically generated by the Swagger Codegen project:

• API version: 0.5
• Package version: 0.5
• Build date: 2016-07-20T00:31:04.788+03:00
• Build package: class io.swagger.codegen.languages.RubyClientCodegen

To build the Ruby code into a gem:

gem build rakam_client.gemspec

Then either install the gem locally:

gem install ./rakam_client-0.5.gem

(for development, run gem install --dev ./rakam_client-0.5.gem to install the development dependencies)

or publish the gem to a gem hosting service, e.g. RubyGems.

Finally add this to the Gemfile:

gem 'rakam_client', '~> 0.5'

If the Ruby gem is hosted at a git repository: https://github.com/rakam-io/rakam-ruby-client, then add the following in the Gemfile:

gem 'rakam_client', :git => 'https://github.com/rakam-io/rakam-ruby-client.git'

Include the Ruby code directly using -I as follows:

ruby -Ilib script.rb

Please follow the installation procedure and then run the following code:

# Load the gem
require 'rakam_client'

# Setup authorization
RakamClient.configure do |config|
  # Configure API key authorization: master_key
  config.api_key['master_key'] = 'YOUR API KEY'
  # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
  #config.api_key_prefix['master_key'] = 'Bearer'
end

api_instance = RakamClient::AdminApi.new

project_add_custom_fields_to_schema = RakamClient::ProjectAddCustomFieldsToSchema.new # ProjectAddCustomFieldsToSchema | 


begin
  #Add fields to collections by transforming other schemas
  result = api_instance.add_custom_fields_to_schema(project_add_custom_fields_to_schema)
  p result
rescue RakamClient::ApiError => e
  puts "Exception when calling AdminApi->add_custom_fields_to_schema: #{e}"
end

All URIs are relative to https://app.rakam.io/

• RakamClient::AnalyzeRequest
• RakamClient::BulkEventRemote
• RakamClient::CheckLockKey
• RakamClient::Collection
• RakamClient::CollectionDefinition
• RakamClient::CollectionEvent
• RakamClient::CommitBulkEvents
• RakamClient::CommitRequest
• RakamClient::Condition
• RakamClient::ConfigItem
• RakamClient::ContinuousQuery
• RakamClient::ContinuousQueryDeleteQuery
• RakamClient::ContinuousQueryGetQuery
• RakamClient::ContinuousQueryGetSchemaOfQuery
• RakamClient::ContinuousQueryTestQuery
• RakamClient::CreatePrecomputedTable
• RakamClient::CreateProject
• RakamClient::EmailActionConfig
• RakamClient::ErrorMessage
• RakamClient::Event
• RakamClient::EventContext
• RakamClient::EventExplorerGetEventStatistics
• RakamClient::EventFilter
• RakamClient::EventFilterAggregation
• RakamClient::EventList
• RakamClient::Execute
• RakamClient::Explain
• RakamClient::ExportQuery
• RakamClient::FunnelQuery
• RakamClient::FunnelStep
• RakamClient::FunnelWindow
• RakamClient::GroupBy
• RakamClient::Library
• RakamClient::MappingPlugin
• RakamClient::MaterializedView
• RakamClient::MaterializedViewDeleteView
• RakamClient::MaterializedViewGetSchemaOfView
• RakamClient::MaterializedViewGetView
• RakamClient::MaterializedViewSchema
• RakamClient::Measure
• RakamClient::MetadataResponse
• RakamClient::ModuleDescriptor
• RakamClient::OLAPTable
• RakamClient::Ordering
• RakamClient::PrecalculatedTable
• RakamClient::ProjectAddCustomFieldsToSchema
• RakamClient::ProjectAddFieldsToSchema
• RakamClient::ProjectApiKeys
• RakamClient::ProjectCheckApiKeys
• RakamClient::ProjectGetStats
• RakamClient::ProjectSchema
• RakamClient::QueryError
• RakamClient::QueryMetadata
• RakamClient::QueryResult
• RakamClient::RealTimeQueryResult
• RakamClient::RealTimeReport
• RakamClient::RealtimeDeleteTable
• RakamClient::RealtimeQueryTable
• RakamClient::Recipe
• RakamClient::Reference
• RakamClient::ResponseQuery
• RakamClient::RetentionAction
• RakamClient::RetentionQuery
• RakamClient::SchemaField
• RakamClient::SchemaFieldInfo
• RakamClient::Sorting
• RakamClient::Stats
• RakamClient::SuccessMessage
• RakamClient::Timeframe
• RakamClient::User
• RakamClient::UserContext
• RakamClient::UserCreateSegment
• RakamClient::UserCreateUsers
• RakamClient::UserEmailActionBatch
• RakamClient::UserEmailActionSend
• RakamClient::UserGetEvents
• RakamClient::UserGetUser
• RakamClient::UserIncrementProperty
• RakamClient::UserSearchUsers
• RakamClient::UserUnsetProperty

• Type: API key
• API key parameter name: read_key
• Location: HTTP header

• Type: API key
• API key parameter name: master_key
• Location: HTTP header

• Type: API key
• API key parameter name: write_key
• Location: HTTP header