File Layouts for Message Center
These are the file layouts for the Message Center export files (which are prefixed with accountID_PUSH_INBOX_). They include Message Center events generated for Message Center messages launched as part of Push campaigns and those launched as Message Center campaigns.
Your account must be enabled for both Mobile App Channel and Message Center.
Message Center events are only supported for customers using the new Connect interface.
All timestamps are presented in UTC with this format: DD-Mon-YYYY HH24:MI:SS
Message Center Sent
A Message Center Sent event is generated and stored in the event tables each time a Message Center Sent event is received after the mobile app is installed (iOS and Android devices).
|
Field Name |
Type and Max Length |
Null? |
Description/Comments |
|---|---|---|---|
|
EVENT_UUID |
VARCHAR(36) |
NO |
Internal ID of the event |
|
EVENT_TYPE_ID |
NUMBER |
NO |
Numerical value that denotes the event type for the given event transaction See Contact Event Type IDs for more information. |
|
ACCOUNT_ID |
NUMBER |
NO |
Account number |
|
LIST_ID |
NUMBER |
|
Numerical identifier of the List object used by the campaign |
|
RIID |
NUMBER |
NO |
Unique ID assigned for this specific List record |
|
CUSTOMER_ID |
VARCHAR2(255) |
|
A unique identifier of the recipient/record that matches a customer ID or unique identifier in your system of record |
|
EVENT_CAPTURED_DT |
TIMESTAMP |
NO |
Date and time the system was informed about the event |
|
EVENT_STORED_DT |
TIMESTAMP |
NO |
Date and time the event transaction was stored into the Event DB |
|
CAMPAIGN_ID |
NUMBER |
NO |
Numerical identifier of the specific campaign |
|
LAUNCH_ID |
NUMBER |
NO |
Numerical identifier of the launch instance |
|
PROGRAM_ID |
NUMBER |
|
Numerical identifier of the Program. -1 if unknown |
|
PUSH_ID |
VARCHAR2(50) |
NO |
Unique identifier of the device and app installed on the device |
|
USER_ID |
VARCHAR2(100) |
NO |
Unique identifier of the user |
|
APP_ID |
VARCHAR2(100) |
NO |
Unique identifier of the app |
|
PLATFORM_TYPE |
VARCHAR2(30) |
NO |
Type of the platform of the device |
| INBOX_ID | NUMBER(38,0) | NO | The unique identifier of the message center inbox |
Message Center Skipped
|
Field Name |
Type and Max Length |
Null? |
Description/Comments |
|---|---|---|---|
|
EVENT_UUID |
VARCHAR2(144) |
NO |
Internal ID of the event |
|
EVENT_TYPE_ID |
NUMBER |
NO |
Numerical value that denotes the event type for the given event transaction See Contact Event Type IDs for more information. |
|
ACCOUNT_ID |
NUMBER |
NO |
Account number (for example, 1234) |
|
LIST_ID |
NUMBER |
NO |
Numerical identifier for the List object used by the Campaign |
|
RIID |
NUMBER |
NO |
Unique ID assigned for this specific List record |
|
CUSTOMER_ID |
VARCHAR2(1020) |
YES |
A unique identifier of the recipient/record that matches a customer ID or unique identifier in your system of record |
|
EVENT_CAPTURED_DT |
TIMESTAMP |
NO |
Date and time the system was informed about the event |
|
EVENT_STORED_DT |
TIMESTAMP |
NO |
Date and time the event transaction was stored into the Event DB |
|
CAMPAIGN_ID |
NUMBER |
NO |
Numerical identifier of the specific campaign |
|
LAUNCH_ID |
NUMBER |
NO |
Numerical identifier of the launch instance |
|
PROGRAM_ID |
NUMBER |
NO |
Numerical identifier of the Program. -1 if unknown |
|
PUSH_ID |
VARCHAR2(200) |
NO |
Unique identifier of the device and app installed on the device |
|
PUSHIO_API_KEY |
VARCHAR2(400) |
NO |
Alphanumeric case sensitive characters: the app GUID, an underscore, a character representing the platform type, and 3 characters representing the platform identifier |
|
APP_ID |
VARCHAR2(400) |
NO |
Unique identifier of the app |
|
USER_ID |
VARCHAR2(2000) |
YES |
Unique identifier of the user |
|
PLATFORM_TYPE |
VARCHAR2(120) |
YES |
Type of the platform of the device |
|
INBOX_ID |
NUMBER |
NO |
The unique identifier of the message center inbox |
|
REASON |
VARCHAR2(1020) |
YES |
Reason for skipping the message |
Message Center Failed
|
Field Name |
Type and Max Length |
Null? |
Description/Comments |
|---|---|---|---|
|
EVENT_UUID |
VARCHAR(36) |
NO |
Internal ID of the event |
|
EVENT_TYPE_ID |
NUMBER |
NO |
Numerical value that denotes the event type for the given event transaction See Contact Event Type IDs for more information. |
|
ACCOUNT_ID |
NUMBER |
NO |
Account number (for example. 1234) |
|
LIST_ID |
NUMBER |
NO |
Numerical identifier for the List object used by the Campaign |
|
RIID |
NUMBER |
NO |
Unique ID assigned for this specific List record |
|
CUSTOMER_ID |
VARCHAR2(1020) |
YES |
A unique identifier of the recipient/record that matches a customer ID or unique identifier in your system of record |
|
EVENT_CAPTURED_DT |
TIMESTAMP |
NO |
Date and time the system was informed about the event |
|
EVENT_STORED_DT |
TIMESTAMP |
NO |
Date the event transaction was stored into the Event DB |
|
CAMPAIGN_ID |
NUMBER |
NO |
Numerical identifier of the specific campaign |
|
LAUNCH_ID |
NUMBER |
NO |
Numerical identifier of the launch instance |
|
PROGRAM_ID |
NUMBER |
NO |
Numerical identifier of the Program. -1 if unknown |
|
PUSH_ID |
VARCHAR2(50) |
YES |
Unique identifier of the device and app installed on the device |
|
API_KEY |
VARCHAR2(400) |
NO |
Alphanumeric case sensitive characters: the app GUID, an underscore, a character representing the platform type, and 3 characters representing the platform identifier |
|
APP_ID |
VARCHAR2(100) |
NO |
Unique identifier of the app |
|
PLATFORM_TYPE |
VARCHAR2(200) |
YES |
Type of the platform of the device |
|
USER_ID |
VARCHAR2(2000) |
YES |
Unique identifier of the user |
|
REASON |
VARCHAR2(255) |
YES |
Reason the message failed |
Message Center Display
A Display event is generated and stored in event tables each time a Message Center message is displayed to mobile app users in a short/preview format (usually as part of a list displayed in the mobile app).
|
Field Name |
Type and Max Length |
Null? |
Description/Comments |
|---|---|---|---|
|
EVENT_UUID |
VARCHAR(36) |
NO |
Internal ID of the event |
|
EVENT_TYPE_ID |
NUMBER |
NO |
Numerical value that denotes the event type for the given event transaction See Contact Event Type IDs for more information. |
|
ACCOUNT_ID |
NUMBER |
NO |
Account number (for example. 1234) |
|
LIST_ID |
NUMBER |
NO |
Numerical identifier for the List object used by the Campaign |
|
RIID |
NUMBER |
NO |
Unique ID assigned for this specific List record |
|
CUSTOMER_ID |
VARCHAR2(1020) |
YES |
A unique identifier of the recipient/record that matches a customer ID or unique identifier in your system of record |
|
EVENT_CAPTURED_DT |
TIMESTAMP |
NO |
Date and time the system was informed about the event |
|
EVENT_STORED_DT |
TIMESTAMP |
NO |
Date the event transaction was stored into the Event DB |
|
CAMPAIGN_ID |
NUMBER |
NO |
Numerical identifier of the specific campaign |
|
LAUNCH_ID |
NUMBER |
NO |
Numerical identifier of the launch instance |
|
PROGRAM_ID |
NUMBER |
NO |
Numerical identifier of the Program. -1 if unknown |
|
PUSH_ID |
VARCHAR2(50) |
YES |
Unique identifier of the device and app installed on the device |
|
API_KEY |
VARCHAR2(400) |
NO |
Alphanumeric case sensitive characters: the app GUID, an underscore, a character representing the platform type, and 3 characters representing the platform identifier |
|
APP_ID |
VARCHAR2(100) |
NO |
Unique identifier of the app |
|
PLATFORM_TYPE |
VARCHAR2(200) |
YES |
Type of the platform of the device |
|
USER_ID |
VARCHAR2(2000) |
YES |
Unique identifier of the user |
Message Center Opened
An Opened event is generated and stored in the event tables each time a mobile app recipient taps a Message Center message to view its detailed promotional content.
|
Field Name |
Type and Max Length |
Null? |
Description/Comments |
|---|---|---|---|
|
EVENT_UUID |
VARCHAR(36) |
NO |
Internal ID of the event |
|
EVENT_TYPE_ID |
NUMBER |
NO |
Numerical value that denotes the event type for the given event transaction See Contact Event Type IDs for more information. |
|
ACCOUNT_ID |
NUMBER |
NO |
Account number (for example. 1234) |
|
LIST_ID |
NUMBER |
|
Numerical identifier for the List object used by the Campaign |
|
RIID |
NUMBER |
NO |
Unique ID assigned for this specific List record |
|
CUSTOMER_ID |
VARCHAR2(255) |
|
A unique identifier of the recipient/record that matches a customer ID or unique identifier in your system of record |
|
EVENT_CAPTURED_DT |
TIMESTAMP |
NO |
Date and time the system was informed about the event. |
|
EVENT_STORED_DT |
TIMESTAMP |
NO |
Date the event transaction was stored into the Event DB. |
|
CAMPAIGN_ID |
NUMBER |
NO |
Numerical identifier of the specific campaign |
|
LAUNCH_ID |
NUMBER |
NO |
Numerical identifier of the launch instance |
|
PROGRAM_ID |
NUMBER |
|
Numerical identifier of the Program. -1 if unknown |
|
PUSH_ID |
VARCHAR2(50) |
NO |
Unique identifier of the device and app installed on the device. |
|
PUSHIO_API_KEY |
VARCHAR2(25) |
NO |
Alphanumeric case sensitive characters: the app GUID, an underscore, a character representing the platform type, and 3 characters representing the platform identifier |
|
PLATFORM_TYPE |
VARCHAR2(30) |
NO |
Type of the platform of the device |
|
APP_ID |
VARCHAR2(100) |
NO |
Unique identifier of the app |
Message Center Clicked
A Clicked event is generated and stored in the event tables each time a mobile app recipients taps a "call to action" link in the body of a rich HTML Message Center message.
|
Field Name |
Type and Max Length |
Null? |
Description/Comments |
|---|---|---|---|
|
EVENT_UUID |
VARCHAR(36) |
NO |
Internal ID of the event |
|
EVENT_TYPE_ID |
NUMBER |
NO |
Numerical value that denotes the event type for the given event transaction See Contact Event Type IDs for more information. |
|
ACCOUNT_ID |
NUMBER |
NO |
Account number (for example, 1234) |
|
LIST_ID |
NUMBER |
|
Numerical identifier for the List object used by the campaign |
|
RIID |
NUMBER |
NO |
Unique ID assigned for this specific List record |
|
CUSTOMER_ID |
VARCHAR2(255) |
|
A unique identifier of the recipient/record that matches a customer ID or unique identifier in your system of record |
|
EVENT_CAPTURED_DT |
TIMESTAMP |
NO |
Date and time the system was informed about the event |
|
EVENT_STORED_DT |
TIMESTAMP |
NO |
Date the event transaction was stored into the Event DB |
|
CAMPAIGN_ID |
NUMBER |
NO |
Numerical identifier of the specific campaign |
|
LAUNCH_ID |
NUMBER |
NO |
Numerical identifier of the launch instance |
|
PROGRAM_ID |
NUMBER |
NO |
Numerical identifier of the Program. -1 if unknown |
|
PUSH_ID |
VARCHAR2(50) |
NO |
Unique identifier of the device and app installed on the device. |
|
PUSHIO_API_KEY |
VARCHAR2(100 CHAR) |
No |
Alphanumeric case sensitive characters: the app GUID, an underscore, a character representing the platform type, and 3 characters representing the platform identifier |
|
APP_ID |
VARCHAR2(100) |
NO |
Unique identifier of the app |
|
PLATFORM_TYPE |
VARCHAR2(30) |
NO |
Type of the platform of the device |
|
OFFER_NAME |
VARCHAR2(255) |
NO |
|
|
OFFER_NUMBER |
NUMBER |
NO |
Numerical identifier used for click tracking |
|
OFFER_CATEGORY |
VARCHAR2(255) |
|
The LINK_CATEGORY value from the campaign’s link table |
|
OFFER_URL |
VARCHAR2(4000) |
NO |
The URL of the “clicked” link that initiated the Conversion |