USPS® Informed Delivery® (ID) Data via Informed Visibility® Mailer Tracking & Reporting (IV® -MTR

Data Dictionary
Change History
Date
5/20/2020
USPS® Informed Delivery® (ID) Data via Informed Visibility® Mailer Tracking & Reporting (IV® -MTR)
Data Dictionary
hange History
Document Change Description
Initial creation
 Purpose
This Data Dictionary describes the data attributes available in the IV-MTR application for Informed Delivery data. Th
Informed Delivery campaigns. For additional information about the IV-MTR application, please refer to IV-MTR Post

Layout
The data attributes in this Data Dictionary are organized by the Record Type to which they apply; the data attributes
listed in the delimited file formats. The following information is provided about each data attribute:
Column
Field Name
JSON Field Name
Field Description
Data Type
Data Length
Can be Null
Sample Data
Fields Available by Record Type
 Purpose
escribes the data attributes available in the IV-MTR application for Informed Delivery data. The application will allow mailers to
paigns. For additional information about the IV-MTR application, please refer to IV-MTR PostalPro™ (https://postalpro.usps.com

his Data Dictionary are organized by the Record Type to which they apply; the data attributes available in the IV-MTR applicatio
ile formats. The following information is provided about each data attribute:
Description
Name of the data attribute displayed for the ID data within the IV-MTR application and in delimited files
Name of the data attribute as displayed in the JSON files
Explanation of what information the data attribute provides
Format of the data attribute field (e.g. alphanumeric)
Maximum number of characters in the data attribute field
Denotes whether the data attribute can contain a blank value
Example data for the data attribute
Denotes the data attributes available for each of the following record types: Piece, Email, Open Details, Click Details
Status
 Post-campaign Data

Field Name JSON Field Name

Barcode Identifier barcodeId

Barcode Mailer ID barcodeMailerId
Barcode Serial Number barcodeSerialNumber
Brand Display Name brandDisplayName
Campaign Code campaignCode
Campaign Title campaignTitle
Delivery Date deliveryDate

eDoc Submitter CRID edocSubmitterCrid

eDoc Submitter Name edocSubmitterName

Email ID emailId

End Date endDate

End Serial endSerial

Image Position in Email imagePositionInEmail

Mail Owner CRID mailOwnerCrid

Mail Owner Name mailOwnerName

Mail Preparer CRID mailPreparerCrid

Mail Preparer Name mailPreparerName

Mailer ID mailerId
Mailer Name mailerName
Mailpiece ID mailpieceId
Service Type Code serviceTypeCode

Source source

Start Date startDate

Start Serial startSerial

Status status

Submitter CRID submitterCrid

When clicked through whenClickedThrough

When email was opened whenEmailWasOpened
When email was sent whenEmailWasSent
ZIP5 zip5

Record Type recordType

 Post-campaign Data

Field Description

Barcode Identifier of the mailpiece IMB Code

Barcode Mailer ID of the mailpiece IMB Code
Serial Number of the mailpiece IMB Code
The name displayed in the “From” field of the campaign
A mailer generated unique code for a campaign
A mailer generated title for a campaign
The date that a mailpiece was processed for delivery
USPS-generated numeric code of up to 15 digits that uniquely identifies a USPS EDOC Submitter (for
PO! campaigns only)
The name of the organization that submitted the electronic documentation to the postal service for
mailing.
A unique identifier for each mailpiece. Automatically generated by USPS
The end date of the campaign as specified by the mailer. The cut-off is at 12 AM of the end date. Mail
processed on the campaign end date will not be included in any reports.
If the campaign is based on IMb Serialized (not MID level) – indicates a six-digit or nine-digit ending
Serial Number.
The position in which the image was displayed in an email (1 means it was the first image, 2 means it
was the second image, etc.)
USPS-generated numeric code of up to 15 digits that uniquely identifies a USPS Mail Owner (for PO!
campaigns only)
The name of the organization that owns the mail being sent.
USPS-generated numeric code of up to 15 digits that uniquely identifies a USPS Mail Preparer (for
PO! campaigns only)
The name of the organization that prepared the mailing and/or delivered it to the postal service for
mailing.
The six-digit or nine-digit numeric code that was submitted for the campaign (for all campaigns)
The name of the owner of the MID that's on the mailpiece IMB
A unique identifier for each piece. Automatically generated by USPS
Service Type Code of the mailpiece IMB Code

Where the click-through originated. Includes the following:

RIDEALONG_WEBSITE - click-through originated from the Learn More link on the dashboard
RIDEALONG_WEBSITE_IMAGE - click-through originated from the campaign image on the
dashboard
RIDEALONG_EMAIL - click-through originated from the Learn More link in the Daily Digest
RIDEALONG_EMAIL_IMAGE - click-through originated from the campaign image in the Daily Digest
The start date of the campaign as specified by the mailer
If the campaign is based on IMb Serialized (not MID level) – indicates a six- or nine-digit starting Serial
Number.
Status of the campaign. Includes the following: ACTIVE, COMPLETE, CANCELLED.
USPS-generated numeric code of up to 15 digits that uniquely identifies a USPS Submitter (for all
campaigns)
The time stamp of when a link from a campaign was clicked using the local time
The time stamp of when an email was opened using the local time
The time stamp of when an email was sent using the local time
The ZIP Code of the subscriber (recipient)

Identifies the type of record being provisioned. Incudes the following:

Non-Email - details for pieces that are not sent in emails
Open Details - details for click tracks
Click Details - details for click tracks
Email - details for emails sent
Piece - details for mailpieces associated to campaigns
Status - details for campaign status updates
 Fields Available by Record Type

Details

Details
Email

Email
Piece

Open

Click
Data Can be

Non-
Data Type Sample Data
Length Null

String 2 Y 01 X X X X X
String 9 Y 123456 X X X X X
String 9 Y 990019102 X X X X X
Alphanumeric 255 N ABC Company X X X X X
Alphanumeric 255 N ABC July 2020 X X X X X
Alphanumeric 255 N ABC071020 X X X X X
Date 10 Y 2020-01-01 X X X X X

Alphanumeric 15 Y 4614860 X X X X X

String 50 Y  ABC Company X X X X X

Alphanumeric 18 Y 1587469 X X X

Date 10 N 2020-08-30 X X X X X

Number 10 Y 987456124 X X X X X

Number 2 Y 3 X X X

Alphanumeric 15 Y 222342884 X X X X X

String 50 Y ABC Company X X X X X

Alphanumeric 15 Y 222342889 X X X X X

String 50 Y ABC Company X X X X X

Alphanumeric 9 N 987546321 X X X X X
String 50 ABC Company X X X X X
Number 28 Y 1254789122 X X X X X
String 3 Y 011 X X X X

Alphanumeric 255 Y RIDEALONG_WEBSITE X

Date 10 N 2020-08-30 X X X X X

Number 10 Y 987456120 X X X X X

Alphanumeric 255 Y ACTIVE X X X X X

Alphanumeric 15 N 123456 X X X X X

Timestamp 24 Y 2020-05-14 01:32:36-0400 X

Timestamp 24 Y 2020-05-14 01:30:36-0400 X X
Timestamp 24 Y 2020-05-14 01:00:36-0400 X X X
Alphanumeric 5 Y 12345 X X X X X

Alphanumeric 13 N Piece X X X X X
ecord Type Campaig
n Status

X
X
X

X
X

X
X
 Date and Time Standards
Within the Data Dictionary, the following standards are used for date and time fields:
Data Type Format Example
DATE YYYY-MM-DD 2020-01-01
TIMESTAMP               
yyyy-MM-dd HH:mm:ssZ 2020-05-14 01:30:36-0400
Time Standards
date and time fields:
Description
Determines the day in which an event occurred
Determines the local date and time in which an event occurred