An analytics platform API that lets you create your own analytics services.
This Python package is automatically generated by the Swagger Codegen project:
- API version: 0.5
- Package version: 0.5
- Build date: 2016-07-20T00:31:02.367+03:00
- Build package: class io.swagger.codegen.languages.PythonClientCodegen
Python 2.7 and 3.4+
If the python package is hosted on Github, you can install directly from Github
pip install git+https://github.com/rakam-io/rakam-python-client.git
(you may need to run pip
with root permission: sudo pip install git+https://github.com/rakam-io/rakam-python-client.git
)
Then import the package:
import rakam_client
Install via Setuptools.
python setup.py install --user
(or sudo python setup.py install
to install the package for all users)
Then import the package:
import rakam_client
Please follow the installation procedure and then run the following:
import time
import rakam_client
from rakam_client.rest import ApiException
from pprint import pprint
# Configure API key authorization: master_key
rakam_client.configuration.api_key['master_key'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# rakam_client.configuration.api_key_prefix['master_key'] = 'Bearer'
# create an instance of the API class
api_instance = rakam_client.AdminApi
project_add_custom_fields_to_schema = rakam_client.ProjectAddCustomFieldsToSchema() # ProjectAddCustomFieldsToSchema |
try:
# Add fields to collections by transforming other schemas
api_response = api_instance.add_custom_fields_to_schema(project_add_custom_fields_to_schema)
pprint(api_response)
except ApiException as e:
print "Exception when calling AdminApi->add_custom_fields_to_schema: %s\n" % e
All URIs are relative to https://app.rakam.io/
Class | Method | HTTP request | Description |
---|---|---|---|
AdminApi | add_custom_fields_to_schema | POST /project/schema/add/custom | Add fields to collections by transforming other schemas |
AdminApi | add_fields_to_schema | POST /project/schema/add | Add fields to collections |
AdminApi | check_api_keys | POST /project/check-api-keys | Create API Keys |
AdminApi | check_lock_key | POST /admin/lock_key | Check lock key |
AdminApi | collections | POST /project/collection | Get collection names |
AdminApi | create_api_keys | POST /project/create-api-keys | Create API Keys |
AdminApi | create_project | POST /project/create | Create project |
AdminApi | delete_project | DELETE /project/delete | Delete project |
AdminApi | get_configurations | GET /admin/configurations | List installed modules |
AdminApi | get_projects | GET /project/list | List created projects |
AdminApi | get_stats | POST /project/stats | Get project stats |
AdminApi | get_types | GET /admin/types | Get types |
AdminApi | revoke_api_keys | DELETE /project/revoke-api-keys | Revoke API Keys |
AdminApi | schema | POST /project/schema | Get collection schema |
CollectApi | batch_events | POST /event/batch | Collect multiple events |
CollectApi | bulk_events | POST /event/bulk | Collect Bulk events |
CollectApi | bulk_events_remote | POST /event/bulk/remote | Collect bulk events from remote |
CollectApi | collect_event | POST /event/collect | Collect event |
CollectApi | commit_bulk_events | POST /event/bulk/commit | Commit Bulk events |
ContinuousqueryApi | create_query | POST /continuous-query/create | Create stream |
ContinuousqueryApi | delete_query | POST /continuous-query/delete | Delete stream |
ContinuousqueryApi | get_query | POST /continuous-query/get | Get continuous query |
ContinuousqueryApi | get_schema_of_query | POST /continuous-query/schema | Get query schema |
ContinuousqueryApi | list_queries | POST /continuous-query/list | List queries |
ContinuousqueryApi | test_query | POST /continuous-query/test | Test continuous query |
EventexplorerApi | analyze_events | POST /event-explorer/analyze | Perform simple query on event data |
EventexplorerApi | create_precomputed_table | POST /event-explorer/pre_calculate | Create Pre-computed table |
EventexplorerApi | get_event_statistics | POST /event-explorer/statistics | Event statistics |
EventexplorerApi | get_extra_dimensions | GET /event-explorer/extra_dimensions | Event statistics |
FunnelApi | analyze_funnel | POST /funnel/analyze | Execute query |
MaterializedviewApi | create_view | POST /materialized-view/create | Create view |
MaterializedviewApi | delete_view | POST /materialized-view/delete | Delete materialized view |
MaterializedviewApi | get_schema_of_view | POST /materialized-view/schema | Get schemas |
MaterializedviewApi | get_view | POST /materialized-view/get | Get view |
MaterializedviewApi | list_views | POST /materialized-view/list | List views |
QueryApi | execute | POST /query/execute | Execute query on event data-set |
QueryApi | explain | POST /query/explain | Explain query |
QueryApi | metadata | POST /query/metadata | Test query |
RealtimeApi | create_table | POST /realtime/create | Create report |
RealtimeApi | delete_table | POST /realtime/delete | Delete report |
RealtimeApi | list_tables | POST /realtime/list | List queries |
RealtimeApi | query_table | POST /realtime/get | Get report |
RecipeApi | export_recipe | GET /recipe/export | Export recipe |
RecipeApi | install_recipe | POST /recipe/install | Install recipe |
RetentionApi | analyze_retention | POST /retention/analyze | Execute query |
UserApi | create_segment | POST /user/create_segment | Get events of the user |
UserApi | create_user | POST /user/create | Create new user |
UserApi | create_users | POST /user/batch/create | Create multiple new users |
UserApi | get_events | POST /user/get_events | Get events of the user |
UserApi | get_metadata | GET /user/metadata | Get user storage metadata |
UserApi | get_user | POST /user/get | Get user |
UserApi | increment_property | POST /user/increment_property | Set user property |
UserApi | search_users | POST /user/search | Search users |
UserApi | set_properties | POST /user/set_properties | Set user properties |
UserApi | set_properties_once | POST /user/set_properties_once | Set user properties once |
UserApi | unset_property | POST /user/unset_properties | Unset user property |
UseractionApi | batch | POST /user/action/email/batch | Apply batch operation |
UseractionApi | send | POST /user/action/email/single | Perform action for single user |
- AnalyzeRequest
- BulkEventRemote
- CheckLockKey
- Collection
- CollectionDefinition
- CollectionEvent
- CommitBulkEvents
- CommitRequest
- Condition
- ConfigItem
- ContinuousQuery
- ContinuousQueryDeleteQuery
- ContinuousQueryGetQuery
- ContinuousQueryGetSchemaOfQuery
- ContinuousQueryTestQuery
- CreatePrecomputedTable
- CreateProject
- EmailActionConfig
- ErrorMessage
- Event
- EventContext
- EventExplorerGetEventStatistics
- EventFilter
- EventFilterAggregation
- EventList
- Execute
- Explain
- ExportQuery
- FunnelQuery
- FunnelStep
- FunnelWindow
- GroupBy
- Library
- MappingPlugin
- MaterializedView
- MaterializedViewDeleteView
- MaterializedViewGetSchemaOfView
- MaterializedViewGetView
- MaterializedViewSchema
- Measure
- MetadataResponse
- ModuleDescriptor
- OLAPTable
- Ordering
- PrecalculatedTable
- ProjectAddCustomFieldsToSchema
- ProjectAddFieldsToSchema
- ProjectApiKeys
- ProjectCheckApiKeys
- ProjectGetStats
- ProjectSchema
- QueryError
- QueryMetadata
- QueryResult
- RealTimeQueryResult
- RealTimeReport
- RealtimeDeleteTable
- RealtimeQueryTable
- Recipe
- Reference
- ResponseQuery
- RetentionAction
- RetentionQuery
- SchemaField
- SchemaFieldInfo
- Sorting
- Stats
- SuccessMessage
- Timeframe
- User
- UserContext
- UserCreateSegment
- UserCreateUsers
- UserEmailActionBatch
- UserEmailActionSend
- UserGetEvents
- UserGetUser
- UserIncrementProperty
- UserSearchUsers
- 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