Get Tracking Code

Returns the tracking code for a campaign.

URL:


            GET https://api.emailonacid.com/v5/analytics/gettrackingcode/<CAMPAIGN GUID>

Example Response:

{
    "tracking_code": "",    
    "guid": "<CAMPAIGN GUID>"
}

Get Campaign Info

Returns basic information for a campaign.

URL:


            GET https://api.emailonacid.com/v5/analytics/getcampaigninfo/<CAMPAIGN GUID>

Request Details:

Element	Type	Description	Default
`guid`	String	The unique identifier of the campaign for which you would like to GET data.	None; Required

Example Response:

{
    "name": "<Campaign Name>",
    "status": "<Campaign Status>",
    "tracking_code": "<Campaign Tracking Code>",
    "total_subscribers": <Total Subscribers>,
    "created_on": "<YYYY-MM-DD HH:MM:SS>",
    "start_date": "<YYYY-MM-DD HH:MM:SS>",
    "end_date": "<YYYY-MM-DD HH:MM:SS>",
    "merge_tag": "<Merge Tag>",
    "read_threshold": <Read Threshold>,
    "skim_threshold": <Skim Threshold>,
    "delete_threshold": <Delete Threshold>,
    "days_remaining": <Days Remaining before campaign expires>,
    "click_tracking": {
        "google": false,
        "html": "<Original Email Source>"
    },
    "guid": "<CAMPAIGN GUID>"
}

Response Details:

Element	Type	Description
`name`	String	The name of the campaign.
`status`	String	The status shows weather or not the campaign is activated yet or not. If activated status will be "current"; otherwise status will be "testing".
`tracking_code`	String	The tracking code for the campaign.
`total_subscribers`	Integer	Campaigns total subscribers.
`created_on`	String	Date and time the campaign was created.
`start_date`	String	Date and time the campaign was activated.
`end_date`	String	Date and time the campaign expires.
`merge_tag`	String	Merge tag used in campaign.
`read_threshold`	Integer	Maximum number of seconds the user has the email open to have it classified as a 'read'. This is for purposes of evaluating customer engagement.
`skim_threshold`	Integer	Maximum number of seconds the user has the email open to have it classified as a 'skim'. This is for purposes of evaluating customer engagement. Beyond this, it counts as a 'read'.
`delete_threshold`	Integer	Maximum number of seconds the user has the email open to have it classified as a 'delete'. This is for purposes of evaluating customer engagement. Beyond this, it counts as a 'skim'.
`days_remaining`	Integer	Amount of days remaining before campaign expires.
`click_tracking`	Object	Click tracking details.
`google`	Boolean	Enable compatibility for links with Google Analytics installed, to allow tracking in both systems.
`html`	String	Original Email Source code.
`guid`	String	The unique identifier for this campaign.

Get Summary Report

Returns an overview of all the reports.

Open Counts
Click Counts
Enagagement Statistics
Per day engagement Statistics
Top 10 Email Clients
Top 5 Links Clicked

URL:


            GET https://api.emailonacid.com/v5/analytics/getsummaryreport/<CAMPAIGN GUID>

Request Details:

Element	Type	Description	Default
`guid`	String	The unique identifier of the campaign for which you would like to GET data.	None; Required

Example Response (Click Tracking Enabled):

{
    "total_opens": 14865,
    "unique_opens": 3333,
    "reads": 7810,
    "skims": 800,
    "deletes": 250,
    "forwards": 65,
    "prints": 18,
    "stats_per_day: {
        "clicks": [
            {
                "day": {
                    "date": "09-14-2023",
                    "amount": 135
                }
            },
            {
                "day": {
                    "date": "09-15-2023",
                    "amount": 183
                }
            },
            ...
            {
                "day": {
                    "date": "10-13-2023",
                    "amount": 150
                }
            }
        ],
        "forwards": [
            {
                "day": {
                    "date": "09-14-2023",
                    "amount": 35
                }
            },
            {
                "day": {
                    "date": "09-15-2023",
                    "amount": 30
                }
            },
            ...
            {
                "day": {
                    "date": "10-13-2023",
                    "amount": 55
                }
            }
        ],
        "opens": [
            {
                "day": {
                    "date": "09-14-2023",
                    "amount": 158
                }
            },
            ...
        ],
        "prints": [
            {
                "day": {
                    "date": "09-14-2023",
                    "amount": 35
                }
            },
            ...
        ],
        "unique_clicks": [
            {
                "day": {
                    "date": "09-14-2023",
                    "amount": 105
                }
            },
            ...
        ],
        "unique_opens": [
            {
                "day": {
                    "date": "09-14-2023",
                    "amount": 95
                }
            },
            {
                "day": {
                    "date": "09-15-2023",
                    "amount": 83
                }
            },
            ...
            {
                "day": {
                    "date": "10-13-2023",
                    "amount": 45
                }
            }
        ]
    },
    "opens_by_environment": {
        "Desktop": 3420,
        "Web": 5622,
        "Mobile": 4860,
        "desktop_rate": <PERCENTAGE OPEN DESKTOP>,
        "web_rate": <PERCENTAGE OPEN WEB>,
        "mobile_rate": <PERCENTAGE OPEN MOBILE>
    },
    "top_10_clients": [
        {
            "client": {
                "client_name": "iPhone 15.2",
                "unique_total": 356,
                "open_total": 1207,
                "client_type": "Mobile"
            }
        },
        {
            "client": {
                "client_name": "Firefox 117 (Other)",
                "unique_total": 150,
                "open_total": 1003,
                "client_type": "Browser"
            }
        },
        ...
        {
            "client": {
                "client_name": "Outlook 16",
                "unique_total": 140,
                "open_total": 856,
                "client_type": "Desktop"
            }
        }
    ],
    "total_clicks": 3456,
    "unique_clicks": 2345,
    "top_5_links": [
        {
            "link": {
                "url": "<EXAMPLE URL 1>",
                "total_clicks": 244,
                "unique_clicks": 200
            }
        },
        {
            "link": {
                "url": "<EXAMPLE URL 2>",
                "total_clicks": 180,
                "unique_clicks": 160
            }
        },
        ...
        {
            "link": {
                "url": ""<EXAMPLE URL 5>",",
                "total_clicks": 150,
                "unique_clicks": 122
            }
        }
    ],
    "guid": "<CAMPAIGN GUID>"
}

Response Details:

Element	Type	Description
`total_opens`	Integer	Total amount of times the email was opened.
`unique_opens`	Integer	Count of unique opens for the email.
`reads`	Integer	How many times the email was read.
`skims`	Integer	How many times the email was skimmed.
`deletes`	Integer	How many times the email was glanced at.
`forwards`	Integer	How many times the email was forwarded.
`prints`	Integer	How many times the email was printed.
`stats_per_day`	Object	Contains 'per day' statistics for clicks, forwards, opens, prints, unique_clicks and unique_opens.
`opens_by_environment`	Object	As below. Gives open count for each environment.
`Desktop`	Integer	Count for opens in desktop email clients.
`Web`	Integer	Count for opens in web email clients.
`Mobile`	Integer	Count for opens in mobile devices.
`desktop_rate`	Float	Percentage of opens in Desktop.
`web_rate`	Float	Percentage of opens in Web.
`mobile_rate`	Float	Percentage of opens in Mobile.
`top_10_clients`	Object	Contains statistics for the top 10 email clients in the campaign.
`total_clicks`	Integer	Total of all link clicks during this campaign.
`unique_clicks`	Integer	Total of all unique link clicks during this campaign.
`top_5_links`	Object	Contains statistics for the top 5 links that were clicked on for the campaign.
`guid`	String	The unique identifier for this campaign.

Get Open Count

Returns total open and unique open counts.

URL:


            GET https://api.emailonacid.com/v5/analytics/getopencount/<CAMPAIGN GUID>

Request Details:

Element	Type	Description	Default
`guid`	String	The unique identifier of the campaign for which you would like to GET data.	None; Required

Example Response:

{
    "total_opens": <TOTAL OPENS>,
    "unique_opens": <UNIQUE OPENS>,
    "guid": "<CAMPAIGN GUID>"
}

Response Details:

Element	Type	Description
`total_opens`	Integer	Total amount of times the email was opened.
`unique_opens`	Integer	Count of unique opens for the email.
`guid`	String	The unique identifier for this campaign.

Get Opens For Month

Returns total open and unique counts for a specific month.

URL:


            GET https://api.emailonacid.com/v5/analytics/getopensformonth/<CAMPAIGN GUID>/<year_month>

Request Details:

Element	Type	Description	Default
`guid`	String	The unique identifier of the campaign for which you would like to GET data.	None; Required
`year_month`	String	The month (and year) to get the open counts for. Must be in the following format: YYYY-MM.	None; Required

Example Response:

{
    "total_opens": <TOTAL OPENS FOR MONTH>,
    "unique_opens": <UNIQUE OPENS>,
    "year_month": "<YYYY-MM>",
    "guid": "<CAMPAIGN GUID>"
}

Response Details:

Element	Type	Description
`total_opens`	Integer	Total amount of times the email was opened.
`unique_opens`	Integer	Count of unique opens for the email.
`year_month`	String	The month (and year) we are getting counts for.
`guid`	String	The unique identifier for this campaign.

Get Engagement Report

Returns engagement statistics for a campaign. Prefetch clients (bots such as Apple Mail Privacy Protection) are not considered engagement, and thereby, not included in the engagement (read, skims, deletes) portion of this report.

URL:


            GET https://api.emailonacid.com/v5/analytics/getengagementreport/<CAMPAIGN GUID>

Request Details:

Element	Type	Description	Default
`guid`	String	The unique identifier of the campaign for which you would like to GET data.	None; Required

Example Response:

{
    "total_opens": 8800,
    "total_reads": 6700,
    "total_skims": 200,
    "total_deletes": 100,
    "total_forwards": 200,
    "total_prints": 0,
    "email_clients": [
        {
            "client": {
                "client_name": "Other",
                "opens": 1200,
                "unique_opens": 100,
                "reads": 1200,
                "read_percentage": 17.91,
                "skims": 0,
                "skim_percentage": 0,
                "deletes": 0,
                "delete_percentage": 0
            }
        },
        {
            "client": {
                "client_name": "Android Mail",
                "opens": 1400,
                "unique_opens": 500,
                "reads": 1200,
                "read_percentage": 17.91,
                "skims": 100,
                "skim_percentage": 50,
                "deletes": 100,
                "delete_percentage": 100
            }
        }, 
        ...
        {
            "client": {
                "client_name": "Outlook",
                "opens": 100,
                "unique_opens": 100,
                "reads": 100,
                "read_percentage": 1.49,
                "skims": 0,
                "skim_percentage": 0,
                "deletes": 0,
                "delete_percentage": 0
            }
        }
        
    ],
    "mobile_devices": [
        {
            "device": {
                "device_name": "iPhone",
                "opens": 1100,
                "unique_opens": 200,
                "reads": 1100,
                "read_percentage": 47,
                "skims": 0,
                "skim_percentage": 0,
                "deletes": 0,
                "delete_percentage": 0
            }
        }, 
        {
            "device": {
                "device_name": "Android",
                "opens": 100,
                "unique_opens": 400,
                "reads": 800,
                "read_percentage": 34,
                "skims": 100,
                "skim_percentage": 100,
                "deletes": 100,
                "delete_percentage": 100
            }
        }
    ],
    "environments": {
        "desktop": {
            "opens": 2600,
            "unique_opens": 400,
            "reads": 700,
            "skims": 100,
            "deletes": 0
        },
        "web": {
            "opens": 3700,
            "unique_opens": 800,
            "reads": 3700,
            "skims": 0,
            "deletes": 0
        },
        "mobile": {
            "opens": 2500,
            "unique_opens": 700,
            "reads": 2300,
            "skims": 100,
            "deletes": 100
        }
    },
    "guid": "<CAMPAIGN GUID>"
}

Response Details:

Element	Type	Description
`total_opens`	Integer	Total amount of times the email was opened.
`total_reads`	Integer	Total amount of times the email was read.
`total_skims`	Integer	Total amount of times the email was skimmed.
`total_deletes`	Integer	Total amount of times the email was glanced at.
`total_forwards`	Integer	Total amount of times the email was forwarded.
`total_prints`	Integer	Total amount of times the email was printed.
`email_clients`	Object	Statistics for each email client the email was opened in.
`client`	Object	Statistics for a specific email client.
`client_name`	String	Name of email client.
`opens`	Integer	Total number of emails opened in this email client.
`unique_opens`	Integer	Total number of unique opens in this email client.
`reads`	Integer	Total number of emails read in this email client.
`read_percentage`	Float	Percentage of email reads in this client compared to every other email client.
`skims`	Integer	Total number of emails skimmed in this email client.
`skim_percentage`	Float	Percentage of email skims in this client compared to every other email client.
`deletes`	Integer	Total number of emails glanced at in this email client.
`delete_percentage`	Float	Percentage of email glances in this client compared to every other email client.
`mobile_devices`	Object	Statistics for each mobile device the email was opened in.
`device`	Object	Statistics for a specific mobile device.
`device_name`	String	Name of mobile device.
`opens`	Integer	Total number of emails opened in this mobile client.
`unique_opens`	Integer	Total number unique opens in this mobile client.
`reads`	Integer	Total number of emails read in this mobile client.
`read_percentage`	Float	Percentage of email reads in this device compared to every other mobile device.
`skims`	Integer	Total number of emails skimmed in this mobile client.
`skim_percentage`	Float	Percentage of email skims in this device compared to every other mobile device.
`deletes`	Integer	Total number of emails glanced at in this mobile client.
`delete_percentage`	Float	Percentage of email glances in this device compared to every other mobile device.
`environments`	Object	Statistics for each environment.
`desktop`	Object	Statistics for desktop based email clients.
`opens`	Integer	Total number of emails opened in desktop clients.
`reads`	Integer	Total number of emails read in desktop clients.
`skims`	Integer	Total number of emails skimmed in desktop clients.
`deletes`	Integer	Total number of emails glanced at in desktop clients.
`web`	Object	Statistics for web based email clients.
`opens`	Integer	Total number of emails opened in web clients.
`reads`	Integer	Total number of emails read in web clients.
`skims`	Integer	Total number of emails skimmed in web clients.
`deletes`	Integer	Total number of emails glanced at in web clients.
`mobile`	Object	Statistics for mobile based email clients.
`opens`	Integer	Total number of emails opened in mobile clients.
`reads`	Integer	Total number of emails read in mobile clients.
`skims`	Integer	Total number of emails skimmed in mobile clients.
`deletes`	Integer	Total number of emails glanced at in mobile clients.
`guid`	String	The unique identifier for this campaign.

Get Email Client Report

Returns break down of email clients the email was opened in and the clients individual statistics.

URL:


            GET https://api.emailonacid.com/v5/analytics/getemailclientreport/<CAMPAIGN GUID>

Request:

Request Details:

Element	Type	Description	Default
`guid`	String	The unique identifier of the campaign for which you would like to GET data.	None; Required

Example Response:

{
    "top_10_clients": [
        {
            "client": {
                "client_name": "Apple Mail Privacy Protection Dark Mode",
                "unique_total": 1000,
                "open_total": 4170,
                "client_type": "Desktop"
            }
        },
        {
            "client": {
                "client_name": "Android 13",
                "unique_total": 450,
                "open_total": 2900,
                "client_type": "Mobile"
            }
        },
        {
            "client": {
                "client_name": "iPhone 16.6",
                "unique_total": 300,
                "open_total": 1300,
                "client_type": "Mobile"
            }
        },
        ...
        {
            "client": {
                "client_name": "Thunderbird 115",
                "unique_total": 100,
                "open_total": 700,
                "client_type": "Desktop"
            }
        }
    ],
    "client_breakdown": [
        {
            "client": {
                "name": "Apple Mail Privacy Protection Dark Mode",
                "opens": 4170,
                "unique_opens": 1000,
                "percent_total": 48.83,
                "percent_unique": 3.33,
                "versions": [
                    {
                        "version": {
                            "name": "Apple Mail Privacy Protection (Dark Mode)",
                            "opens": 417,
                            "unique_opens": 1,
                            "percent_total": 48.83,
                            "percent_unique": 3.33
                        }
                    }
                ]
            }
        },
        {
            "client": {
                "name": "Android",
                "opens": 6900,
                "unique_opens": 1300,
                "percent_total": 8.08,
                "percent_unique": 43.33,
                "versions": [
                    {
                        "version": {
                            "name": "Android 13",
                            "opens": 2900,
                            "unique_opens": 450,
                            "percent_total": 3.4,
                            "percent_unique": 13.33
                        }
                    },
                    {
                        "version": {
                            "name": "Android 12",
                            "opens": 1300,
                            "unique_opens": 300,
                            "percent_total": 1.52,
                            "percent_unique": 10
                        }
                    },
                    ...
                    {
                        "version": {
                            "name": "Android 10",
                            "opens": 300,
                            "unique_opens": 100,
                            "percent_total": 0.35,
                            "percent_unique": 3.33
                        }
                    }
                ]
            }
        },
        ...
        {
            "client": {
                "name": "iPhone",
                "opens": 400,
                "unique_opens": 100,
                "percent_total": 0.47,
                "percent_unique": 3.33,
                "versions": [
                    {
                        "version": {
                            "name": "iPhone 16.6",
                            "opens": 400,
                            "unique_opens": 100,
                            "percent_total": 0.47,
                            "percent_unique": 3.33
                        }
                    }
                ]
            }
        }
    ],
    "guid": "<CAMPAIGN GUID>"
}

Response Details:

Element	Type	Description
`top_10_clients`	Object	List of the top ten email clients.
`client`	Object	Specific client information.
`client_name`	String	The name of the email client.
`unique_total`	Integer	Count of unique opens in the client.
`open_total`	Integer	Count of opens in the client.
`client_breakdown`	Object	List all email clients, their statistics and the statistics for the different versions of each client. See below.
`client`	Object	Specific client information. See below.
`name`	String	The name of the client.
`opens`	Integer	Count of opens in the client.
`unique_opens`	Integer	Count of unique opens in the client.
`percent_total`	Float	Percentage of total opens for this client compared to all of the other clients.
`percent_unique`	Float	Percentage of total unique opens for this client compared to all of the other clients.
`versions`	Object	List of all the different client versions and their statistics. See below.
`version`	Object	A specific versions statistics. See below.
`name`	String	The name of the client version.
`opens`	Integer	Count of opens in the client version.
`unique_opens`	Integer	Count of unique opens in the client version.
`percent_total`	Float	Percentage of total opens for this client version compared to all of the other versions of this client.
`percent_unique`	Float	Percentage of total unique opens for this client version compared to all of the other versions of this client.
`guid`	String	The unique identifier for this campaign.

Get Geolocation Report

Returns geolocation statistics for a campaign.

URL:


            GET https://api.emailonacid.com/v5/analytics/getgeolocationreport/<CAMPAIGN GUID>

Request Details:

Element	Type	Description	Default
`guid`	String	The unique identifier of the campaign for which you would like to GET data.	None; Required

Example Response:

{
    "country_stats": {
        "AF": {
            "country_code": "AF",
            "country_name": "Afghanistan",
            "total_opens": 0
        },
        "AL": {
            "country_code": "AL",
            "country_name": "Albania",
            "total_opens": 2
        },
        "DZ": {
            "country_code": "DZ",
            "country_name": "Algeria",
            "total_opens": 0
        },
        ...
        "US": {
            "country_code": "US",
            "country_name": "United States",
            "total_opens": 11200
        },
        ...
        "ZM": {
            "country_code": "ZM",
            "country_name": "Zambia",
            "total_opens": 0
        },
        "ZW": {
            "country_code": "ZW",
            "country_name": "Zimbabwe",
            "total_opens": 12
        }
    },
    "guid": "<CAMPAIGN GUID>"
}

Response Details:

Element	Type	Description
`country_stats`	Object	Contains statistics for every country using the country code as the element name.
`<COUNTRY>`	Object	Stats for an individual country.
`country_code`	String	2 digit country code, such as "US" or "CA".
`country_name`	String	Country name, such as "United States" or "Canada".
`total_opens`	Integer	Total amount of times the email was opened in this country.
`guid`	String	The unique identifier for this campaign.

Get Click Tracking Report

Returns click tracking statistics for a campaign.

URL:


            GET https://api.emailonacid.com/v5/analytics/getclicktrackingreport/<CAMPAIGN GUID>

Request Details:

Element	Type	Description	Default
`guid`	String	The unique identifier of the campaign for which you would like to GET data.	None; Required

Response:

{
    "total_clicks": 4000,
    "unique_clicks": 3000,
    "links": [
        {
            "link": {
                "url": "<EXAMPLE URL 1>",
                "total_clicks": 2000,
                "unique_clicks": 1500
            }
        }, 
        {
            "link": {
                "url": "<EXAMPLE URL 2>",
                "total_clicks": 1000,
                "unique_clicks": 890
            }
        },
        {
            "link": {
                "url": "<EXAMPLE URL 3>",
                "total_clicks": 2100,
                "unique_clicks": 1550
            }
        }
    ],
    "guid": "<CAMPAIGN GUID>"
}

Response Details:

Element	Type	Description
`total_clicks`	Integer	Count of total clicks for the campaign.
`unique_clicks`	Integer	Count of unique clicks for the campaign.
`links`	Object	List of all links and their statistics.
`link`	Object	Statistics for an individual link.
`url`	String	The destination url for the link.
`total_clicks`	Integer	Click count for the link.
`unique_clicks`	Integer	Unique click count for the link.
`guid`	String	The unique identifier for this campaign.

Overview

Campaign Searches

API Calls

API Lookups

Get Tracking Code

URL:

Example Response:

Get Campaign Info

URL:

Request Details:

Example Response:

Response Details:

Get Summary Report

URL:

Request Details:

Example Response (Click Tracking Enabled):

Response Details:

Get Open Count

URL:

Request Details:

Example Response:

Response Details:

Get Opens For Month

URL:

Request Details:

Example Response:

Response Details:

Get Engagement Report

URL:

Request Details:

Example Response:

Response Details:

Get Email Client Report

URL:

Request:

Request Details:

Example Response:

Response Details:

Get Geolocation Report

URL:

Request Details:

Example Response:

Response Details:

Get Click Tracking Report

URL:

Request Details:

Response:

Response Details: