Mailocator 2 REST API

Last update: 24-07-2020

Endpoint

https://api.mailocator.com/

Developer environment

If you have a valid API key, you can try following queries at https://api.mailocator.com/test/

Authorization

Send following header with Base64 encoded API key: Authorization: Basic **************************

Returned data

Output format can be specified by the last query parameter, like: /api/1.0/request/XML One of the following data formats - XML, JSON or CSV is required.

Methods list:

GET Ping
Check connection and validate your API key
/api/1.0/ping/time HTTP/1.1 200 OK
{"status":1,"error":0,"mesg":"Request successful","timestamp":1595621265} HTTP/1.1 401 Unauthorized
{"status":0,"error":true,"mesg":"Authorization failed: Invalid API key!"}

GET Campaigns

Get list of all your campaigns with activity status
/api/1.0/campaign/list/XML HTTP/1.1 200 OK

<?xml version="1.0" encoding="UTF-8"?>
<LIST>
	<ITEM>
		<id>123456</id>
		<url>static.mailocator.com</url>
		<title>Mailocator Static</title>
		<active>1</active>
	</ITEM>
</LIST>

GET Billing data

Get total consumed credits of all your campaigns in given period FROM/TO
/api/1.0/campaign/billing/YYYYMMDD/YYYYMMDD/XML HTTP/1.1 200 OK

<?xml version="1.0" encoding="UTF-8"?>
<LIST>
	<ITEM>
		<id>123456</id>
		<title>Mailocator Static</title>
		<url>static.mailocator.com</url>
		<total_credits>714091</total_credits>
	<ITEM>
</LIST>

GET Visitors

Get count of daily vistors of CAMPAIGN_ID in given period FROM/TO
/api/1.0/campaign/visitors/123456/YYYYMMDD/YYYYMMDD/XML HTTP/1.1 200 OK

<?xml version="1.0" encoding="UTF-8"?>
<LIST>
	<ITEM>
		<day>20200415</day>
		<desktop>22</desktop>
		<smartphone>9</smartphone>
	</ITEM>
	<ITEM>
		<day>20200416</day>
		<cdesktop>45</desktop>
		<smartphone>69</smartphone>
	</ITEM>
	...
	...
	...
</LIST>

GET Triggered objects

Get count of daily triigered objects of CAMPAIGN_ID in given period FROM/TO
/api/1.0/campaign/triggers/123456/YYYYMMDD/YYYYMMDD/XML HTTP/1.1 200 OK

<?xml version="1.0" encoding="UTF-8"?>
<LIST>
	<ITEM>
		<day>20200415</day>
		<ab>A</ab>
		<desktop>21</desktop>
		<smartphone>3</smartphone>
		<desktop_conversions>2</desktop_conversions>
		<smartphone_conversions>1</smartphone_conversions>		
	</ITEM>
	<ITEM>
		<day>20200415</day>
		<ab>B</ab>
		<desktop>4</desktop>
		<smartphone>3</smartphone>
		<desktop_conversions>0</desktop_conversions>
		<smartphone_conversions>0</smartphone_conversions>		
	</ITEM>
	...
	...
	...
</LIST>