File Layouts for Push
These are the layouts of the Push and In-App export files.
NOTE: All timestamps are presented in UTC with this format: DD-Mon-YYYY HH24:MI:SS
Sent
Supported for both Push and In-App campaigns.
|
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 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 |
Bounced
NOTE: This event type is only supported for customers using the new Connect interface.
A Bounced event is generated and stored in the event tables each time a Bounce 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 (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 |
|
LAUNCH_ID |
NUMBER |
NO |
Numerical identifier of the launch instance |
|
CAMPAIGN_ID |
NUMBER |
NO |
Numerical identifier of the specific campaign |
|
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 |
|
REASON |
VARCHAR2(255) |
|
Reason the message failed |
|
REASON_CODE |
VARCHAR2(500) |
|
The bounce message as provided by the ISP. ISP bounce message: Informational text the ISP provides when bouncing a message. This informational text is important in determining if a block has occurred, and also includes ways to contact the ISP regarding questions |
|
PLATFORM_TYPE |
VARCHAR2(30) |
NO |
Type of the platform of the device |
|
CATEGORY |
|
|
|
|
ERROR_TRACE |
VARCHAR2(4000) |
NO |
Additional information provided by partners, logged for debugging purposes. |
Clicked
NOTE: This event type is only supported for customers using the new Connect interface.
A Clicked event is generated and stored in the event tables each time a Click 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 (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 |
|
LAUNCH_ID |
NUMBER |
NO |
Numerical identifier of the launch instance |
|
CAMPAIGN_ID |
NUMBER |
NO |
Numerical identifier of the specific campaign |
|
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 |
|
OPERATING_SYSTEM |
|
|
|
|
OFFER_NAME |
VARCHAR2(255) |
NO |
The name of the link. |
|
OFFER_NUMBER |
NUMBER |
NO |
Numerical identifier used for click tracking |
|
OFFER_CATEGORY |
VARCHAR2(255) |
|
The link category value. 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 |
|
USER_AGENT_STRING |
VARCHAR2(512) |
YES |
Available only if enabled for your account. The User Agent String, which identifies the user’s device and browser version. |
Skipped
Supported for both Push and In-App campaigns.
|
Field Name |
Type and Max Length |
Null? |
Description/Comments |
|---|---|---|---|
|
EVENT_UUID |
VARCHAR2(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 |
|
USER_ID |
VARCHAR2(100) |
NO |
Unique identifier of the user |
|
APP_ID |
VARCHAR2(100) |
NO |
Unique identifier of the app |
|
REASON |
VARCHAR2(255) |
|
Reason for skipping the message. |
|
PLATFORM_TYPE |
VARCHAR2(30) |
NO |
Type of the platform of the device. |
Failed
Supported for both Push and In-App campaigns.
|
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 |
|
USER_ID |
VARCHAR2(100) |
NO |
Unique identifier of the user |
|
APP_ID |
VARCHAR2(100) |
NO |
Unique identifier of the app |
|
REASON |
VARCHAR2(255) |
|
Reason the message failed |
|
PLATFORM_TYPE |
VARCHAR2(30) |
NO |
Type of the platform of the device |
Button Clicked
Supported only for Push campaigns.
|
Field Name |
Type and Max Length |
Null? |
Description/Comments |
|---|---|---|---|
|
ACCOUNT_ID |
NUMBER(38,0) |
No |
Account number (for example, 1234) |
|
EVENT_UUID |
VARCHAR2(36 CHAR) |
No |
Internal ID of the event. |
|
EVENT_TYPE_ID |
NUMBER(38,0) |
No |
Numerical value that denotes the event type for the given event transaction See Contact Event Type IDs for more information. |
|
RIID |
NUMBER(38,0) |
No |
Unique ID assigned for this specific List record |
|
CUSTOMER_ID |
VARCHAR2(255 CHAR) |
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 |
|
LIST_ID |
NUMBER(38,0) |
No |
Numerical identifier for the List object used by the Campaign |
|
LAUNCH_ID |
NUMBER(38,0) |
No |
Numerical identifier of the launch instance |
|
CAMPAIGN_ID |
NUMBER(38,0) |
No |
Numerical identifier of the specific campaign |
|
PROGRAM_ID |
NUMBER(38,0) |
No |
Numerical identifier of the Program. -1 if unknown |
|
PUSH_ID |
VARCHAR2(355 CHAR) |
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 CHAR) |
No |
Unique identifier of the app. |
|
PLATFORM_TYPE |
VARCHAR2(30 CHAR) |
No |
Type of the platform of the device. |
|
BUTTON_ID |
NUMBER(38,0) |
No |
Unique identifier of the button. |
|
CATEGORY_ID |
NUMBER(38,0) |
No |
Numerical identifier of the category of buttons the user can choose to click |
|
BUTTON_NAME |
VARCHAR2(100 CHAR) |
No |
Name of the button, for example “ACCEPT” |
|
BUTTON_TYPE |
CHAR(1 CHAR) |
No |
Either an “F” (the user was redirected to a URL) or a “B” (the user was not redirected to a URL) |
|
ACTION_URL |
VARCHAR2(2083 CHAR) |
Yes |
The URL that opens after the push button is clicked |
|
CATEGORY_NAME |
VARCHAR2(38 CHAR) |
Yes |
Name of the button category, for example “ACCEPT OR DECLINE” |
|
CATEGORY_IDENTIFIER |
|
Yes |
Unique identifier of the category of buttons the user can choose to click, for example “orcl_rsys_accept_decline” |
|
USER_AGENT_STRING |
VARCHAR2(512 CHAR) |
Yes |
Available only if enabled for your account. The User Agent String, which identifies the user’s device and browser version. |
Opened
Supported only for Push campaigns, not for In-App campaigns.
|
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 |
Converted
Supported only for Push campaigns, not for In-App campaigns.
|
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 |
|
CONVERSION_TYPE |
VARCHAR2(50) |
NO |
Enables Marketers to understand the reason for each Conversion Event in the CED Feed. Possible values are: social, premium, purchase, iap, other. You can re-order the default column order on an as-needed basis. |
|
PLATFORM_TYPE |
VARCHAR2(30) |
NO |
Type of the platform of the device |
|
APP_ID |
VARCHAR2(100) |
NO |
Unique identifier of the app |
|
ORDER_ID |
VARCHAR2(255) |
|
The order ID value of the specific order as passed by you when registering the Conversion |
|
ORDER_TOTAL |
NUMBER(18,2) |
The total amount of the order as passed by you when registered in the Conversion |
|
|
ORDER_QUANTITY |
NUMBER(18,2) |
The total number of items in the order as passed by you when registering the Conversion / Purchase |
|
|
CUSTOM_PROPERTIES |
Opted In
NOTE: This event type is only supported for customers using the new Connect interface.
A Push Opted In event is generated and stored in the event tables when:
-
The mobile app is installed on an Android device.
-
On every Opt In received after the mobile app is installed (iOS and Android devices).
Whenever a Push Opted In event occurs, a Customer Activated Program event is also generated. This enables marketers to use the Customer Activated Program event for orchestration logic in programs.
|
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 |
|
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 |
|
APP_ID |
VARCHAR2(100) |
NO |
Unique identifier of the app |
|
PLATFORM_TYPE |
VARCHAR2(30) |
NO |
Type of the platform of the device |
|
USER_ID |
VARCHAR2(100) |
|
Unique identifier of the user. Only captured if the user is logged in to the mobile app when they opt in. This field helps identify the user that opted in. |
Opted Out
NOTE: This event type is only supported for customers using the new Connect interface.
A Push Opted Out event is generated and stored in the event tables each time an Opt Out 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 (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 and time the event transaction was stored into the Event DB |
|
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 |
|
APP_ID |
VARCHAR2(100) |
NO |
Unique identifier of the app |
|
PLATFORM_TYPE |
VARCHAR2(30) |
NO |
Type of the platform of the device |
|
USER_ID |
VARCHAR2(100) |
|
Unique identifier of the user. Only captured if the user is logged in to the mobile app when they opt out. This field helps identify the user that opted out. |
Uninstalled
NOTE: This event type is only supported for customers using the new Connect interface.
A Uninstalled event is generated and stored in the event tables each time an Uninstall 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 (for example, 1234) |
|
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 |
|
LIST_ID |
NUMBER |
|
Numerical identifier for the List object used by the campaign |
|
PUSH_ID |
VARCHAR2(50) |
NO |
Unique identifier of the device and app installed on the device |
|
USER_ID |
VARCHAR2(100) |
|
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 |