Skip to main content

Alooma python API

Project description

# Alooma's Python SDK
Manage your real-time data pipeline with Alooma's Python SDK. Our Python SDK allows you to perform all the operations enabled by our UI and more with Python code.

## Getting started

```python
import alooma

alooma = alooma.Alooma(hostname="<your sub-domain>.alooma.io", username="<your username>", password="<your password>")
```

### get_config()
To get the system's configuration, use:
```python
config = alooma.get_config()
```

## get_structure()
To get your system's structure, use:
```python
structure = alooma.get_structure()
```

## get_mapping_mode()
To get your system's mapping mode (FLEXIBLE/STRICT), use:
```python
mapping_mode = alooma.get_mapping_mode()
```
## Not yet documented functions:

* `create_s3_input(name, key, secret, bucket, prefix, load_files, transform_id)`
* `create_mixpanel_input(mixpanel_api_key, mixpanel_api_secret, from_date, name, transform_id)`
* `create_input(input_post_data)`
* `get_transform_node_id`
* `remove_input(input_id)`
* `set_transform_to_default()`
* `set_mapping(mapping, event_type_name)`
* `set_mapping_mode(flexible)`
* `discard_event_type(event_type_name)`
* `discard_field(mapping, field_path)`
* `unmap_field(mapping, field_path)`
* `map_field(schema, field_path, column_name, field_type, non_null, **type_attributes)`
* `find_field_name(schema, field_path, add_if_missing=False)`
* `set_input_sleep_time(id, sleep_time)`
* `get_transform()`
* `get_incoming_queue_metric(minutes)`
* `get_throughput_by_name(name)`
* `get_incoming_events_count(minutes)`
* `get_average_event_size(minutes)`
* `get_max_latency(minutes)`
* `get_tables()`
* `get_notifications(epoch_time)`
* `get_plumbing()`
* `get_redshift_config()`
* `clean_system()`
* `remove_all_inputs()`
* `delete_all_event_types()`
* `delete_event_type(event_type)`
* `get_event_types()`
* `get_event_type(event_type_name)`
* `set_settings_email_notifications(email_settings_json)`
* `delete_s3_retention()`
* `clean_restream_queue()`
* `start_restream()`
* `get_restream_queue_size()`

Project details


Release history Release notifications | RSS feed

Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

alooma-0.1.9.5.tar.gz (6.4 kB view hashes)

Uploaded Source

Supported by

AWS AWS Cloud computing and Security Sponsor Datadog Datadog Monitoring Fastly Fastly CDN Google Google Download Analytics Microsoft Microsoft PSF Sponsor Pingdom Pingdom Monitoring Sentry Sentry Error logging StatusPage StatusPage Status page