File Layouts for Web Push
These are the layouts of the Web Push files.
NOTE: All timestamps are presented in UTC with this format: DD-Mon-YYYY HH24:MI:SS
Sent
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 |
VISITOR_ID |
VARCHAR2(255) |
NO |
Unique identifier of the website visitor |
APP_ID |
NUMBER(38,0) |
NO |
Unique identifier of the app. |
API_KEY |
VARCHAR2(100) |
NO |
Platform for the Web Push app. |
PLATFORM_TYPE |
VARCHAR2(30) |
NO |
Type of the platform of the device |
USER_ID |
VARCHAR2(500) |
|
Unique identifier of the user. For logged in users, it contains the value of the USER_IDENTIFIER (match key) from the Web Push app. For logged out users, it contains null. |
Skipped
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 |
NO |
Numerical identifier of the Program. -1 if unknown |
VISITOR_ID |
VARCHAR2(255) |
NO |
Unique identifier of the website visitor. |
USER_ID |
VARCHAR2(500) |
|
Unique identifier of the user. For logged in users, it contains the value of the USER_IDENTIFIER (match key) from the Web Push app. For logged out users, it contains null. |
APP_ID |
NUMBER(38,0) |
NO |
Unique identifier of the app. |
API_KEY |
VARCHAR2(100) |
NO |
Platform for the Web Push app. |
REASON |
VARCHAR2(255) |
NO |
Reason for skipping the message. |
PLATFORM_TYPE |
VARCHAR2(30) |
NO |
Type of the platform of the device. |
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 |
|
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 |
VISITOR_ID |
VARCHAR2(255) |
NO |
Unique identifier of the website visitor |
APP_ID |
NUMBER(38,0) |
NO |
Unique identifier of the app. |
API_KEY |
VARCHAR2(100) |
NO |
Platform for the Web Push app. |
CATEGORY |
VARCHAR2(255) |
NO |
|
REASON |
VARCHAR2(255) |
NO |
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 |
ERROR_TRACE |
VARCHAR2(4000) |
NO |
Additional information provided by partners, logged for debugging purposes. |
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.
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 |
VISITOR_ID |
VARCHAR2(255) |
NO |
Unique identifier of the website visitor |
APP_ID |
NUMBER(38,0) |
NO |
Unique identifier of the app. |
API_KEY |
VARCHAR2(100) |
NO |
Platform for the Web Push app. |
CATEGORY |
VARCHAR2(255) |
NO |
|
BOUNCE_TYPE |
CHAR(1) |
NO |
Hard or Soft bounce H = Hard bounce S = Soft Bounce |
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 |
ERROR_TRACE |
VARCHAR2(4000) |
NO |
Additional information provided by partners, logged for debugging purposes. |
PLATFORM_TYPE |
VARCHAR2(30) |
NO |
Type of the platform of the device. |
USER_ID |
VARCHAR2(500) |
|
Unique identifier of the user. For logged in users, it contains the value of the USER_IDENTIFIER (match key) from the Web Push app. For logged out users, it contains null. |
Opened
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 |
||
VISITOR_ID |
VARCHAR2(255) |
NO |
Unique identifier of the website visitor |
||
APP_ID |
NUMBER(38,0) |
NO |
Unique identifier of the app. |
||
API_KEY |
VARCHAR2(100) |
NO |
Platform for the Web Push app. |
||
PLATFORM_TYPE |
VARCHAR2(30) |
NO |
Type of the platform of the device. |
Button Clicked
Field Name |
Type and Max Length |
Null? |
Description/Comments |
---|---|---|---|
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. |
ACCOUNT_ID |
NUMBER(38,0) |
NO |
Account number (for example. 1234) |
LIST_ID |
NUMBER(38,0) |
NO |
Numerical identifier for the List object used by the Campaign. |
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. |
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. |
VISITOR_ID |
VARCHAR2(255) |
NO |
Unique identifier of the website visitor |
API_KEY |
VARCHAR2(100) |
NO |
Platform for the Web Push app. |
APP_ID |
NUMBER(38,0) |
NO |
Unique identifier of the app. |
PLATFORM_TYPE |
VARCHAR2(30 CHAR) |
NO |
Type of the platform of the device. |
BUTTON_CLICK_ID |
NUMBER |
NO |
Identifier of the button. Value will be 1 or 2. |
BUTTON_NAME |
VARCHAR2(255 CHAR) |
NO |
Name of the button, for example “ACCEPT”. |
BUTTON_URL |
VARCHAR2(2048 CHAR) |
NO |
URL path of the button. |
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 |
VISITOR_ID |
VARCHAR2(255) |
NO |
Unique identifier of the website visitor |
APP_ID |
NUMBER(38,0) |
NO |
Unique identifier of the app. |
API_KEY |
VARCHAR2(100) |
NO |
Platform for the Web Push app. |
PLATFORM_TYPE |
VARCHAR2(30) |
NO |
Type of the platform of the device. |
CONVERSION_TYPE |
VARCHAR2(50) |
NO |
Identifier for the conversion type. |
ORDER_ID |
VARCHAR2(50) |
|
The order ID value of the specific order as passed by you when registering the Conversion. The value from the OrderID name-value pair when calling the Conversion Tracking image pixel |
ORDER_TOTAL |
NUMBER(15,2) |
|
The total amount of the order as passed by you when registered in the Conversion. The value from the OrderTotal name-value pair when calling the Conversion Tracking image pixel |
ORDER_QUANTITY |
NUMBER(38,0) |
|
The total number of items in the order as passed by you when registering the Conversion / Purchase The value from the NumItem name-value pair when calling the Conversion Tracking image pixel |
USER_ID |
VARCHAR2(500) |
|
Unique identifier of the user. For logged in users, it contains the value of the USER_IDENTIFIER (match key) from the Web Push app. For logged out users, it contains null. |
Closed
NOTE: This event type is only supported for customers using the new Connect interface.
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 |
VISITOR_ID |
VARCHAR2(255) |
NO |
Unique identifier of the website visitor |
API_KEY |
VARCHAR2(100) |
NO |
Platform for the Web Push app. |
APP_ID |
NUMBER(38,0) |
NO |
Unique identifier of the app. |
PLATFORM_TYPE |
VARCHAR2(30) |
NO |
Type of the platform of the device. |
Opted In
NOTE: This event type is only supported for customers using the new Connect interface.
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 |
NUMBER(38,0) |
NO |
Unique identifier of the app. |
PLATFORM_TYPE |
VARCHAR2(30) |
NO |
Type of the platform of the device. |
USER_ID |
VARCHAR2(500) |
|
Unique identifier of the user. For logged in users, it contains the value of the USER_IDENTIFIER (match key) from the Web Push app. For logged out users, it contains null. |
Opted Out
NOTE: This event type is only supported for customers using the new Connect interface.
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 |
VISITOR_ID |
VARCHAR2(255) |
NO |
Unique identifier of the website visitor |
API_KEY |
VARCHAR2(100) |
NO |
Unique identifier of the |
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(500) |
|
Unique identifier of the user. For logged in users, it contains the value of the USER_IDENTIFIER (match key) from the Web Push app. For logged out users, it contains null. |