Mr. Mail Tracker API Documentation

---

Mail Tracking by ZIP Code

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

Example URL:
https://MrMailTracker.com/api/track_mailing_zip?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": "06801 "
    }, {
        "lat": null,
        "delivered": 2,
        "lng": null,
        "mailed": 2,
        "title": "06810 "
    }, {
        "lat": null,
        "delivered": 3,
        "lng": null,
        "mailed": 3,
        "title": "06811 "
    }, {
        "lat": null,
        "delivered": 4,
        "lng": null,
        "mailed": 4,
        "title": "07016 "
    }
]
        

Response information:

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

lat

The latitude value of the map coordinates of the ZIP code. (If null, the coordinates for this ZIP code 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 ZIP code.

lng

The longitude value of the map coordinates of the ZIP code. (If null, the coordinates for this ZIP code 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 ZIP code.

title

The ZIP code.