Mr. Mail Tracker API Documentation


Tracked Mailing

Purpose: Get the tracking information for a particular mailing.

Example URL:
https://MrMailTracker.com/api/track_mailing?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: 

{
    "job_id": "103120",
    "mailing_id": "55382",
    "mail_class": "First Class",
    "mail_piece": "Postcard",
    "mail_date": "02/15/2012",
    "track_qty": 1345,
    "delivery_stats": [
        {
            "date": "02/17/2012",
            "delivered": 604,
            "mailed": 635,
            "deliver_percent": 44.909999999999997,
            "mail_percent": 47.210000000000001
        }, {
            "date": "02/18/2012",
            "delivered": 621,
            "mailed": 692,
            "deliver_percent": 46.170000000000002,
            "mail_percent": 51.450000000000003
        }, {
            "date": "02/21/2012",
            "delivered": 18,
            "mailed": 18,
            "deliver_percent": 1.3300000000000001,
            "mail_percent": 1.3300000000000001
        }
    ]
}

Response information:
job_id
An identifer for a job that might include several mailings.
mailing_id
A unique identifier for a specific mailing.
mail_class
Class of mail. Will be one of the following:
  • First Class
  • Periodicals
  • Standard
mail_piece
USPS clasification of mail piece. Will be one of the following:
  • Postcard
  • Letter
  • Flat
mail_date
Date mail was sent out.
track_qty
Number of mail pieces tracked for this mailing.
delivery_stats
An array containing the delivery statistics broken down by delivery date, each containing the following:
date
The delivery date.
delivered
Number of pieces determined to be delivered on this date based on the scans received from the USPS.
mailed
The sum of two numbers:
  • The "delivered" pieces.
  • The number of pieces not confirmed delivered but which are anticipated to be delivered on this date based on the USPS service standards.
Example: 604 pieces were confirmed delivered by the scans results received from the USPS. Another 31 have not been confirmed delivered but were anticipated to be delivered on this date based on the service standard for these pieces. The "mailed" quantity will be the sum of these two numbers: 635.
deliver_percent
The "delivered" quantity as a percentage of the total mail quantity.
mail_percent
The "mailed" quantity as a percentqage of the total mail quantity.