Mailmodo 0ff833fb

Mailmodo Support

Raise a Ticket here

The campaign dashboard gives you the option to export the overview report that is presented on it. Additionally, there are different data lists you could download depending upon what you need. This article takes you through the steps that you need to follow and the various options available to you. 

 by clicking on the icon on the sidebar.

Click on the campaign from the list of campaigns.

If it is a trigger campaign whose data you wish to export, 

and select the campaign from the (campaign) list there.

The Campaign Dashboard will appear. Click on 

From the drop-down list you can choose to export three kinds of data lists. 

- This makes available to you all the data from the campaign overview that is displayed on the dashboard. 

 - This gives you information about the number of clicks for different subject lines used. 

 - Responses filled out by users will be compiled and exported.  

 - The number of contacts who didn't recieve the campaign due to soft bounce or a hard bounce.

All data that you choose to export will be downloaded in the form of a .CSV file. 

How to export campaign level data from the dashboard

Mailmodo email campaigns data (overall as well as date-range specific) can be exported to your software stack or MIS via this API.

Following is the API request structure to do the same:

 You need to include this before each API endpoint to make API calls.

To export overall campaign data (all campaigns data/ data within a specified date range):

 https://api.mailmodo.com/api/v1/campaignReports/ 

 https://api.mailmodo.com/api/v1/campaignReports/<campaignId 

Mailmodo APIs are completely RESTful. All Mailmodo APIs are authorized via an API key.

 to view the default API key. (You may also create a new API Key by clicking on the 'Add new API Key' button)

data is received in the following JSON format:

"data": [        {            "campaignId": "753a31db-29ab-483f-b8ba-xxxxxxx",            "campaignType": "CONTACT_LIST",            "campaignName": "Job",            "status": "Processed",            "senderEmail": "magic@mailmodo.com",            "subjects": [                "Application"            ],            "createdAt": "2021-01-04T12:48:29.818Z",            "scheduledAt": "2021-01-04T12:48:22.465Z",            "bounced": 0,            "complaints": 0,            "submission": 0,            "unsubscribed": 0,            "blocked": 0,            "scheduled": 0,            "sent": 0,            "delivered": 0,            "clicks": 0,            "ampClicks": 0,            "htmlClicks": 0,            "ampOpens": 0,            "htmlOpens": 0,            "opens": 0        },

"campaignType" can be "CONTACT_LIST"(for scheduled campaigns) or "TRIGGERED" (for triggered campaigns)

When date range is entered in body, data for all campaigns preceding the specified end date is displayed (for scheduled campaigns outside the date range, data will show as displayed above, with all metrics as 0)

Exporting email campaigns data via API

Mailmodo has a Webhook integration that lets you export data easily. In an email campaign, you can export all form submissions to an external database using Webhook.

You can add the integration from the template builder itself by following these simple steps:

Form submission to external apps button 

in the top-right corner. This option is only available if your template has a form in it. 

You can Click on the pen icon on the top to change the name of the form.

: Under select integration for Untitled Form 1, click on 'Webhook'. Click on 

 Scroll down and map the submission fields corresponding to Webhook.

 You can now send your campaign. All form submissions will be posted in this Webhook URL. 

The raw data will appear in a JSON string like this :

In the JSON we will send the following fields:

The contact data including name, number, email, etc.,

Form data such as form id, step ids, number of fields and/or steps.

Submission data such as submission source, time of submission, recipient email, etc.,

Upon successful integration, you will see the integrated app below the form. Click on the three dots to stop exporting submissions for that form.

Only submissions won't be exported for this form. You can add it back again anytime. 
The integration will not be removed from your account.

Webhook configuration will not be saved when you duplicate a form or template or use a form as a saved block. Be sure to configure the webhook if you want to export submissions.

Another point to note, in the webhook the data that will be sent to you will be two-fold. First, the form submission data will be sent. Second, we will send the data used to trigger the campaign.

What are the various types of submission sources in this webhook payload?

There are primarily three ways a person can open the content of an email. 

 If the submission is done directly within an AMP page (e.g. an AMP form or star rating).

 If the submission is done in HTML (a new page may open to show a preview) (e.g. a star rating from HTML).

 If the submission is done after opening a page in the browser and filling out items there, then clicking submit (e.g. a form from HTML).

Exporting Mailmodo template submissions to your software stack using Webhook

To use the Mailmodo APIs to send an email template, trigger a campaign or add a contact into a list, users require mmAPI key, template id and campaign id in respective cases to configure the API.

 Follow the steps to get these details from your Mailmodo account. 

You would see a pre-made default API key for your account. You can use that or create a new API key by clicking on Add New API Key button. 

 Click on Show API Key to get the API key on the screen.

 Copy the API Key and paste it into your system.

 Click on the View button of the respective template.

 Copy the template Id and Paste it into your system. 

 Go to Trigger under Campaigns section in the left menu and select a campaign.

 The campaign ID can be found in the URL of the campaign.

Note: The following method is only valid when the campaign is triggered via REST API.

 Go to the Trigger under Campaigns section in the left menu.

 Select your created Template and click Next.

 Add Campaign Details like Campaign Name, Subject, Pre-header,  From Name and Reply to email.

 Select the Rest API option in the Trigger on events section and Click Next to review the campaign.

Once the campaign is reviewed, click on enable the campaign to get the campaign id in the form of the API endpoint. 

 Click on the Copy URL and paste it into your system to complete the setup.

How to get the mmAPI key, template id and campaign id?

To use the Mailmodo APIs to create a dynamic form, users require mmAPI key, form id and campaign id  to configure the API.

 Click on the Edit button of the respective template to go into the editor. 

 Click on the Configuration Form option. 

 Switch Open the Dynamic form option to get the Form Id. 

 Copy the form Id and Paste it into your system. 

 Go to the transactional page under trigger under campaigns.

 Click on the create trigger campaign button.

 Select the relevant template and Click 

 Add the Campaign details and Click Next to select the trigger through the API option. 

 Select the Rest API option in the Trigger on events section and Click Next to review the campaign. 

 Once the campaign is reviewed, click on enable the campaign to get the campaign id in the form of the API endpoint. 

 Click on the Copy URL and paste it into your system to complete the setup. 

How to get the mmAPI key, form id and campaign id?

To use the Mailmodo APIs to send data for repeatable block in the campaign, users require mmAPI key, block id and campaign id  to configure the API.

 In the template editor, switch on the repeatable block option for the block.   

 Click on the Copy button to copy the Block id. 

 Click on the Create trigger campaign button.

 Add the Campaign details and Click Next to select the trigger through the API option.

 Click on the Copy URL and paste it into your system to complete the setup.  

How to get the mmAPI key, campaign id and block id?

To use the Mailmodo APIs to trigger or abort the journey for a contact, users require mmAPI key and  journey id in respective cases to configure the API.

You would see a pre-made default API key for your account. You can use that or create a new API key by clicking on Add New API Key button.

 Click 'Enroll Contacts' button on the respective journey to trigger. 

 In the Add through API section, copy the journey ID from the API endpoint.  

How to get the mmAPI key and Journey id?

Following are the use-cases that can be achieved through APIs in Mailmodo:

Triggering dynamic mails through your software stack in Mailmodo (ref 

Triggering Journeys in Mailmodo from your application (ref 

Importing contacts in Mailmodo from your software stack (ref 

Exporting email campaigns data via API (ref 

Endpoints are used for interacting with server-side web APIs, as they specify where resources lie that can be accessed by third-party software. Usually, the access is via a URL to which HTTP requests are posted, and from which the response is expected.

Simply put, API Endpoints help you to get your apps to communicate with each other.

e.g. You can get the trigger endpoint URL from a transactional Campaign in the following format:

https://api.mailmodo.com/api/v1/triggerCampaign/<campaign id>

) is a unique identifier used to authenticate a user, developer, or calling program to an 

. You can get API keys from Mailmodo using the following path:

 to view the default API key. (You may also create a new API Key by clicking on the 'Add API Key' button)

API and Webhook

How to export campaign level data from the dashboard

Exporting email campaigns data via API

Exporting Mailmodo template submissions to your software stack using Webhook

How to get the mmAPI key, template id and campaign id?

How to get the mmAPI key, form id and campaign id?

How to get the mmAPI key, campaign id and block id?

How to get the mmAPI key and Journey id?

API Reference Guide