Skip to main content

Zaius Export API Interface

Project description

zaius_export: export api for custom reporting

Using zaius_export, you can build and automate custom reports. Like this:

import datetime
import zaius.export as export

# count the users who clicked this week
last_week = - datetime.timedelta(days=7)
last_week = datetime.datetime.fromordinal(last_week.toordinal()).replace(tzinfo=datetime.timezone.utc)

query = """
select zaius_id
from events
  event_type = 'email'
  and action = 'click'
  and ts > {}
rows = export.API().query(query)
print(len(set([r['zaius_id'] for r in rows])))

Or, use pre-baked reports. Like this:

$ zaius-export product-attribution 2019-1-1 2019-1-31

Or This:

$ zaius-export lifecycle-progress 2018-1 2019-1

Or This:

$ zaius-export email-metrics 9097 2019-4-25 2020-4-25

Replace '9097' with the campaign ID you want to view metrics for. Replace '2019-4-25 2020-4-25' with the timerange of your choice. This timerange reflects the times assigned to the 'Scheduled Campaign Run Time' field of email send events. For each of the send events that meet that time range, any and all opens, clicks, and spamreports are counted if they happened, irregardless of when they happened. This timerange also serves as the lower and upper bounds in which unsubscribe events happened.

You can specify the output file. This example creates an export.csv file in the Documents directory:

$ zaius-export --output ~/Documents/export.csv product-attribution 2019-1-1 2019-1-31


Installation happens in the usual way:

$ pip install zaius_export

Now the zaius-export utility should be on your PATH.


API calls depend on having a set of credentials available to authenticate your request. By default, all tools will look for these to be defined in $HOME/.zaius_api. This file should look like this:

aws_access_key_id: ***
aws_secret_access_key: ***
zaius_secret_key: ***

You can find the appropriate values for this file by logging into Zaius. Click the gear icon next to your business name at the top left of the screen, select "APIs" from the menu on the left (under Data Management), and then find your zaius_secret_key under the Private tab.

Your AWS credentials can be found in the Integrations section (Gear Icon, Data Management, Integrations) by opening the AWS integration.


We use SemVer for versioning. For the versions available, see the tags on this repository.


This project is licensed under the MIT License - see the LICENSE file for details.

Project details

Download files

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

Source Distribution

zaius_export-1.5.tar.gz (13.6 kB view hashes)

Uploaded Source

Built Distribution

zaius_export-1.5-py3-none-any.whl (18.8 kB view hashes)

Uploaded Python 3

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