Skip to main content
Join the official 2019 Python Developers SurveyStart the survey!

Python API Client for Localytics Raw Data Export and Audience Export

Project description

Python Client for Localytics Raw and Audience Data Export

This is a Python API Client to get data from Localytics Raw Data Export and Localytics Audience Data Export.

It allows to export all events and sessions and user defined audience captured by Localytics. Data is written in JSON (Compressed) and available on hourly basis as log files.

Installation

istall it by pip

    $ pip install pylocalytics

Usage

Start by loading the library and also you need to import timedelta and datetime on most cases.

    >>> from pylocalytics import pyLocalytics
    >>> from datetime import datetime
    >>> from datetime import timedelta

Setup and Authentication

In order for you to download Localytics events, you need to authenticate with using api_key and api_secret. Once you supply it, it will be used throughout the entire session. You can find you API_KEY and API_SECRET_KEY in your Localytics Admin Panel on Admin Setting API Key

    >>> loctx = pylocalytics(api_key = 'YOU_API_KEY', api_secret= 'YOUR_API_SECRET_KEY')

Download Data

There is a method download_data that downloads data to local folder. Example shows how to export data for last 2 days:

    >>> loctx.download_data(
            app_ids = ['YOUR_APP_ID'],
            start_date = datetime.today() - timedelta(2),
            end_date = datetime.today()
        )

You can also specify optional parameters. This is more complex example:

    >>> loctx.download_data(
        app_ids = [YOUR_APP_ID],
        start_date = datetime.today() - timedelta(2),
        end_date = datetime.today(),
        destination_folder = 'data',
        compressed=True
    )

On default data are stored in localytics_data folder and compressed in gz format. IF don't want to store the compressed version and just need Json file, set compressed = False.

Because I'm working on a project which collect our App data from the Localytics and them import them to our Data WareHouse , I'm working on this Library and If I see some global features which is useful for others, I'll add it.

Project details


Release history Release notifications

This version

1.0

Download files

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

Files for pylocalytics, version 1.0
Filename, size File type Python version Upload date Hashes
Filename, size pylocalytics-1.0-py3-none-any.whl (3.1 kB) File type Wheel Python version py3 Upload date Hashes View hashes
Filename, size pylocalytics-1.0.tar.gz (2.8 kB) File type Source Python version None Upload date Hashes View hashes

Supported by

Elastic Elastic Search Pingdom Pingdom Monitoring Google Google BigQuery Sentry Sentry Error logging AWS AWS Cloud computing DataDog DataDog Monitoring Fastly Fastly CDN SignalFx SignalFx Supporter DigiCert DigiCert EV certificate StatusPage StatusPage Status page