loadChannelsStats.md

Load Channels Statistics

This is a guide how to load statistics for each channel from your account in an easy way using JavaScript or TypeScript.

Required Access Level: ViewChannels

What statistics can you get?

When you send emails with SMTP or API, we organize your email flow by channels and create statistics reports for each channel. Reports iclude eg. number of emails sent, delivered, opened, unsubscribed, number of clicked messages etc.

Preparation

Create a new TypeScript file snippet.ts and open it in editor of your preference eg. Visual Studio Code (https://code.visualstudio.com/)

Let's dig into the code

Put the below code to your file.

Import classes and interfaces you want to use:

import { Configuration, StatisticsApi } from '@elasticemail/elasticemail-client-ts-axios';

Create config including your apikey:

const config = new Configuration({
    apiKey: "YOUR_API_KEY"
});

Create an instance of StatisticsApi that will be used to load channels statistics.

const statisticsApi = new StatisticsApi(config);

Specify report 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

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

This example will show how to fetch information about your all campaigns.

const limit = 0; // number
const offset = 0; // number

Create a function calling statisticsChannelsGet method from the API to load channels statistics. You may include console logs called when response comes back. In case of error it will display error details, otherwise it will display a success message and chosen details about newly created campaign.

const loadChannelsStats = (limit: number, offset: number): void => {
    statisticsApi.statisticsChannelsGet(limit, offset).then((response) => {
        console.log('API called successfully.');
        console.log(response.data);
    }).catch((error) => {
        console.error(error);
    });
};

And finally, call loadChannelsStats function with proper arguments:

loadChannelsStats(limit, offset);

The whole code to copy and paste:

/* Initialization */
import { Configuration, StatisticsApi } from '@elasticemail/elasticemail-client-ts-axios';

/* Generate and use your API key */

const config = new Configuration({
    apiKey: "YOUR_API_KEY"
});

const statisticsApi = new StatisticsApi(config);

const limit = 0; // number
const offset = 0; // number

const loadChannelsStats = (limit: number, offset: number): void => {
    statisticsApi.statisticsChannelsGet(limit, offset).then((response) => {
        console.log('API called successfully.');
        console.log(response.data);
    }).catch((error) => {
        console.error(error);
    });
};

loadChannelsStats(limit, offset)