Name		Name	Last commit message	Last commit date
Latest commit History 22 Commits
exponea_python_sdk		exponea_python_sdk
tests		tests
.gitignore		.gitignore
LICENSE		LICENSE
README.md		README.md
requirements.txt		requirements.txt
setup.py		setup.py

Repository files navigation

Exponea Python SDK

An official Python client for Exponea Data API

Installation

pip install exponea-python-sdk

Usage

from exponea_python_sdk import Exponea
exponea = Exponea("project_token", username="basic_auth_username", password="basic_auth_password")

You can now fully utilize all four API, which are Analyses, Catalog, Customer and Tracking API described bellow.

Tests

To run tests, run the following command

python -m pytest

Logging

To configure logging, use the attribute exponea.logger where a standard logger from Python logging module is initalized. For example, to enable DEBUG messages, you can configure

exponea.logger.setLevel("DEBUG")

Official documenation

For official Exponea documenation of Data API please see https://developers.exponea.com/v2/reference

Table of Contents

Customer API
Analyses API
Catalog API
Tracking API

Catalog API

create_catalog

exponea.catalog.create_catalog("catalog_name", ["field_one", "field_two"])

Parameter	Type	Required
catalog_name	`String`	Yes
fields	`Array<String>`	Yes

It returns ID of the catalog as a String.

d2b69e7s987b0asa0137455f2

get_catalog_name

exponea.catalog.get_catalog_name("catalog_id")

Parameter	Type	Required
catalog_id	`String`	Yes

It returns name of the catalog as a String.

test_catalog

get_catalog_items

exponea.catalog.get_catalog_items("catalog_id", params={})

Parameter	Type	Required
catalog_id	`String`	Yes
params	`Dictionary`	No

Note: params is a kwargs argument.

It returns items of the catalog that match the query and filters specified in params Dictionary. See official documentation for what kind of options you can give to params Dictionary.

{
    "matched": 2,
    "limit": 20,
    "skip": 0,
    "data": [{"item_id": "1", "properties": {"field_one": "foo", "field_two": "baz"}}],
    "matched_limited": False,
    "total": 2
}

update_catalog_item

exponea.catalog.update_catalog_item("catalog_id", "1", {"field_one": "new_value"})

Parameter	Type	Required
catalog_id	`String`	Yes
item_id	`String`	Yes
properties	`String`	Yes

It returns Boolean of whether the operation was successful.

True

update_catalog_name

exponea.catalog.update_catalog_name("catalog_id", "new_name", ["fiel_one", "field_two", "field_three"])

Parameter	Type	Required
catalog_id	`String`	Yes
new_name	`String`	Yes
fields	`Array<String>`	Yes

Note: fields must contain those fields that already exist.

It returns Boolean of whether the operation was successful.

True

create_catalog_item

exponea.catalog.create_catalog_item("catalog_id", "item_id", { "field_one": "value_one" })

Parameter	Type	Required
catalog_id	`String`	Yes
item_id	`String`	Yes
properties	`Dictionary`	Yes

Note: This operation replaces an already existing item if the IDs match.

It returns Boolean of whether the operation was successful.

True

update_catalog_item

exponea.catalog.update_catalog_item("catalog_id", "item_id", { "field_one": "value_one" })

Parameter	Type	Required
catalog_id	`String`	Yes
item_id	`String`	Yes
properties	`Dictionary`	Yes

Note: Updates only those fields that are specified in properties Dictionary.

It returns Boolean of whether the operation was successful.

True

delete_catalog_item

exponea.catalog.delete_catalog_item("catalog_id", "item_id")

Parameter	Type	Required
catalog_id	`String`	Yes
item_id	`String`	Yes

It returns Boolean of whether the operation was successful.

True

delete_catalog_items

exponea.catalog.delete_catalog_items("catalog_id")

Parameter	Type	Required
catalog_id	`String`	Yes

It returns Boolean of whether the operation was successful.

True

delete_catalog

exponea.catalog.delete_catalog("catalog_id")

Parameter	Type	Required
catalog_id	`String`	Yes

It returns Boolean of whether the operation was successful.

True

Tracking API

get_system_time

exponea.tracking.get_system_time(batch=False)

Parameter	Type	Required
batch	`Boolean`	No

Note: The batch kwarg specifies whether command is used in the batch mode. See batch_commands method for details.

It returns a Float.

1533663283.8943756

update_customer_properties

exponea.tracking.update_customer_properties({ "registered": "test" }, { "first_name": "Lukas" }, batch=False)

Parameter	Type	Required
customer_ids	`Dictionary`	Yes
properties	`Dictionary`	Yes
batch	`Boolean`	No

Note: The Customer's properties will get updated with the values of the properties Dictionary.

Note: The batch kwarg specifies whether command is used in the batch mode. See batch_commands method for details.

It returns Boolean describing whether operation was successful or not.

True

add_event

exponea.tracking.add_event({ "registered": "test" }, "event_type", properties={ "property": "sample_property" }, timestamp=1533663283, batch=False)

Parameter	Type	Required
customer_ids	`Dictionary`	Yes
event_type	`String`	Yes
properties	`Dictionary`	No
timestamp	`Float`	No
batch	`Boolean`	No

Note: properties, timestamp and batch parameters are kwargs.

Note: The batch kwarg specifies whether command is used in the batch mode. See batch_commands method for details.

It returns Boolean describing whether operation was successful or not.

True

batch_commands

exponea.tracking.batch_commands([
    exponea.tracking.add_event({ "registered": "test" }, "event_type", properties={ "property": "test" }, batch=True),
    exponea.tracking.update_customer_properties({ "registered": "test" }, { "first_name": "Lukas" }, batch=True),
    exponea.tracking.get_system_time(batch=True)
])

Parameter	Type	Required
commands	`Array<Dictionary>`	Yes

See official documentation for the available formats of different types of commands. It returns an Array of Booleans describing whether each operation was successful or not.

[True, True, 1533833512.6860783]

Customer API

get_customer

exponea.customer.get_customer({ "registered": "test", "cookie": "123" })

Parameter	Type	Required
customer_ids	`Dictionary`	Yes

Note: The keys of the Dictionary are the names of the ID type, and value is the value for a given customer.

It returns a Dictionary.

{
    "events": [{
        "type": "test",
        "timestamp": 1533495544.343536,
        "properties": {}
    }],
    "properties": {
        "first_name": "Lukas",
        "last_nam": "Cerny"
    },
    "ids": {
        "registered": "test",
        "cookie": "123"
    }
}

get_customer_consents

exponea.customer.get_customer_consents({"registered": "test"}, [ "newsletter", "other" ])

Parameter	Type	Required
customer_ids	`Dictionary`	Yes
consent_types	`Array<String>`	Yes

It returns a Dictionary.

{
    "newsletter": True,
    "other": False
}

get_customer_attributes

exponea.customer.get_customer_attributes({"registered": "test"}, ids=["cookie", "ga"], properties=["first_name"], aggregations=["agg_id"], segmentations=["segm_id"], predictions=["pred_id"], expressions=["expr_id"])

Parameter	Type	Required
customer_ids	`Dictionary`	Yes
ids	`Array<String>`	No
properties	`Array<String>`	No
aggregations	`Array<String>`	No
expressions	`Array<String>`	No
segmentations	`Array<String>`	No
predictions	`Array<String>`	No
expressions	`Array<String>`	No

Note: All the arguments are kwargs and specify the attributes you want to recieve.

It returns a Dictionary.

{
    "ids": {
        "cookie": [],
        "ga": "sample_id"
    },
    "properties": {
        "first_name": "Lukas"
    },
    "aggregations": {
        "agg_id": "sample_aggregate"
    },
    "segmentations": {
        "segm_id": "sample_segment"
    },
    "predictions": {
        "pred_id": "sample_prediction"
    },
    "expressions": {
        "expr_id": "sample_expression"
    }
}

Note: If you do not specify one of the attribute types, it will not have a key in the resulting Dictionary.

get_customers

exponea.customer.get_customers()

Parameter	Type	Required

It returns an Array.

[
    {
        "ids": {
            "cookie": [],
            "registered": "test"
        },
        "properties": {
            "first_name": "Lukas",
            "last_name": "Cerny"
        }
    }
]

get_events

exponea.customer.get_events({ "registered": "test" }, [ "event_type" ])

Parameter	Type	Required
customer_ids	`Dictionary`	Yes
event_types	`Array<String>`	Yes

Note: Elements of event_types Array are names of Events.

It returns an Array.

[
    {
        "properties":{
            "foo": "baz"
        },
        "timestamp":1533495529.9268496,
        "type": "event_type"
    }
]

anonymize_customer

exponea.customer.anonymize_customer({ "registered": "test" })

Parameter	Type	Required
customer_ids	`Dictionary`	Yes

It returns a Boolean if operation was successful or not.

True

Analyses API

get_report

exponea.analyses.get_report("report_id")

Parameter	Type	Required
report_id	`String`	Yes

It returns a Dictionary. The elements in data represent individual rows.

{
    "name": "report_name",
    "data": [
        {
            "column_name_1": "value_1",
            "column_name_2": 1
        }
    ]
}

get_funnel

exponea.analyses.get_funnel("funnel_id")

Parameter	Type	Required
funnel_id	`String`	Yes

It returns a Dictionary. The elements in data represent individual drill downs.

{
    "name": "funnel_name",
    "data": [
        {
            "serie": "serie_name",
            "step 1 step_one_name count": 2,
            "step 2 step_two_name count": 1,
            "step 2 event_name duration from previous": 435764.1615576744
        }
    ]
}

get_segmentation

exponea.analyses.get_segmentation("segmentation_id")

Parameter	Type	Required
segmentation_id	`String`	Yes

It returns a Dictionary. The elements in data represent individual segments.

{
    "name": "segmentation_name",
    "data": [
        {
            "segment": "segment_name_1",
            "#": 0
        }
    ]
}