Customer.io Python bindings

This module has been tested with Python 2.7.

Installing

pip install customerio

Usage

from customerio import CustomerIO
cio = CustomerIO(site_id, api_key)
cio.identify(id=5, email='[email protected]', name='Bob', plan='premium')
cio.track(customer_id=5, name='purchased')
cio.track(customer_id=5, name='purchased', price=23.45)

Instantiating customer.io object

from customerio import CustomerIO
cio = CustomerIO(site_id, api_key)

Create or update a Customer.io customer profile

cio.identify(id=5, email='[email protected]', name='Bob', plan='premium')

Only the id field is used to identify the customer here. Using an existing id with a different email (or any other attribute) will update/overwrite any pre-existing values for that field.

You can pass any keyword arguments to the identify and track methods. These kwargs will be converted to custom attributes.

See original REST documentation here

Track a custom event

cio.track(customer_id=5, name='purchased')
cio.track(customer_id=5, name='purchased', price=23.45)

You can pass any keyword arguments to the identify and track methods. These kwargs will be converted to custom attributes.

See original REST documentation here

Backfill a custom event

from datetime import datetime, timedelta

customer_id = 5
event_type = "purchase"

# Backfill an event one hour in the past
event_date = datetime.utcnow() - timedelta(hours=1)
cio.backfill(customer_id, event_type, timestamp, price=23.45, coupon=True)

event_timestamp = 1408482633
cio.backfill(customer_id, event_type, event_timestamp, price=34.56)

event_timestamp = "1408482680"
cio.backfill(customer_id, event_type, event_timestamp, price=45.67)

Event timestamp may be passed as a datetime.datetime object, an integer or a string UNIX timestamp

Keyword arguments to backfill work the same as a call to cio.track.

See original REST documentation here

Delete a customer profile

cio.delete(customer_id=5)

Deletes the customer profile for a specified customer.

This method returns nothing. Attempts to delete non-existent customers will not raise any errors.

See original REST documentation here

You can pass any keyword arguments to the identify and track methods. These kwargs will be converted to custom attributes.

Note regarding timestamps

The library will automatically convert any datetime objects into UNIX timestamps, but assumes that you are using naive (not TZ-aware) datetime objects when generating a timestamp. Please ensure that any datetime objects get converted into a naive form before sending with customerio-python.

Thanks

• Dimitriy Narkevich for creating the library.
• EZL for contributing customer deletes and improving README
• Noemi Millman for adding custom JSON encoder
• Jason Kraus for event backfilling