Mr. Mail Tracker API Documentation

---

Mail Tracking by City

Purpose: Get the tracking results by city for a particular mailing.

Example URL:
https://MrMailTracker.com/api/track_mailing_city?login_id=49&user_id=20&key=GsF6CkPmErRh&mailing_id=55382

Query String Parameters:

user_id

The ID of the user making the request.

login_id

The ID of the user to which the API key was assigned. (Can be the same as the user_id.)

key

The random key used to authenticate the user.

mailing_id

The unique identifier of the mailing you need to retrive tracking results for.

Sample response:

[
    {
        "lat": null,
        "delivered": 2,
        "lng": null,
        "mailed": 2,
        "title": "Harvest, Alabama"
    }, {
        "lat": null,
        "delivered": 4,
        "lng": null,
        "mailed": 4,
        "title": "Anthem, Arizona"
    }, {
        "lat": null,
        "delivered": 16,
        "lng": null,
        "mailed": 16,
        "title": "Phoenix, Arizona"
    }, {
        "lat": null,
        "delivered": 6,
        "lng": null,
        "mailed": 6,
        "title": "Tempe, Arizona"
    }, {
        "lat": null,
        "delivered": 1,
        "lng": null,
        "mailed": 1,
        "title": "Applegate, California"
    }
]
        

Response information:

The response is an array contianing the delivery statistics for each city that was in the mailing list.

lat

The latitude value of the map coordinates of the city. (If null, the coordinates for this city are not in the database. If you need the coordinates, make a call to the API at the path: /api/process_geocodes and the coordinates will be fetched.)

delivered

Number of pieces confirmed delivered for this city.

lng

The longitude value of the map coordinates of the city. (If null, the coordinates for this city are not in the database. If you need the coordinates, make a call to the API at the path: /api/process_geocodes and the coordinates will be fetched.)

mailed

Number of pieces in this mailing that were sent to this city.

title

The name of the city.