Skip to content

loadChannelsStats.md

Latest commit

 

History

History
109 lines (76 loc) · 3.42 KB

loadChannelsStats.md

File metadata and controls

109 lines (76 loc) · 3.42 KB
Raw

Load Channels Statistics

This guide will walk you through steps of loading statistics for each channel from your account using the Python library.

Required Access Level: ViewChannels

What statistics are returned?

When sending emails using Elastic Email with SMTP or API, Elastic Email organizes your email flow by channels. Statistics reports for each channel are being created eg. number of emails sent, number of delivered messages,Number of opened messages, number of unsubscribed messages, number of clicked messages etc.

Preparation

Install Python 3.

Install ElasticEmail library.

Eg. run in terminal pip install ElasticEmail to install from PyPi repository.

Create a new Python file snippet.py and open it in editor of your preference eg. PyCharm (https://www.jetbrains.com/pycharm/download/)

Let's dig into the code

Put the below code to your file.

Load libraries using below code:

import ElasticEmail
from pprint import pprint

Generate and use your API key (remember to check a required access level).

Defining the host is optional and defaults to https://api.elasticemail.com/v4

configuration = ElasticEmail.Configuration()
configuration.api_key['apikey'] = 'YOUR_API_KEY'

Pass configuration to an api client and make it instance available under api_client name:

with ElasticEmail.ApiClient(configuration) as api_client:

Create an instance of StatisticsApi that will be used to get basic send statistics.

    api_instance = ElasticEmail.StatisticsApi(api_client)

Channels statistics reponse is paginated you need to specfiy pagination options:

  • limit – maximum returned items, limit = 0 means to return everything till the end of the list
  • offset – how many items should be skipped from begging

Eg. to return second page of elements paginated 20 elements per page specify pagination options as follows

    api_response = api_instance.statistics_channels_get(limit=20, offset=20)

Find out more by checking our API's documentation: https://elasticemail.com/developers/api-documentation/rest-api#operation/statisticsChannelsGet

Let's fetch first 100 channels:

    api_response = api_instance.statistics_channels_get(limit=100, offset=0)

Use try & except block to call statistics_channels_get method from the API to fetch statistics:

    try:
        api_response = api_instance.statistics_channels_get(limit=100, offset=0)
        pprint(api_response)
    except ElasticEmail.ApiException as e:
        print("Exception when calling StatisticsApi->statistics_channels_get: %s\n" % e)

The whole code to copy and paste:

import ElasticEmail
from pprint import pprint

# Defining the host is optional and defaults to https://api.elasticemail.com/v4
configuration = ElasticEmail.Configuration()

# Configure API key authorization: apikey
configuration.api_key['apikey'] = 'YOUR_API_KEY'

"""
Load channels stats
Example api call that loads a list of your channels' stats.
"""
with ElasticEmail.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = ElasticEmail.StatisticsApi(api_client)

    try:
        api_response = api_instance.statistics_channels_get(limit=100, offset=0)
        pprint(api_response)
    except ElasticEmail.ApiException as e:
        print("Exception when calling StatisticsApi->statistics_channels_get: %s\n" % e)

Run the code

python3 snippet.py