Contents x
    Experience Events Report
    • 28 Jan 2025
    • 2 Minutes to read
    • Print
    • Dark
      Light
    Contents

    Experience Events Report

    • Updated on 28 Jan 2025
    • 2 Minutes to read
    • Print
    • Dark
      Light
    Article summary

    Standard Report: Experience Events

    Purpose:

    A flat file option for ingesting experience events. Clients not requiring real time event synchronization OR clients limited by technology resources are able to ingest Experience Events Reports and receive the same level of detail as the Push API. This report is available in both Staging and Production Environments.

    Included Events:

    Expected Frequency:

    The default frequency is daily.

    Clients may request the frequency be increased to 4x a day.

    In these cases, reports will run with a 1 hour offset, meaning a 6am report will include data from 11pm the prior day to 5am the day of the report.

    To account for the potential data delays to the data warehouse in excess of 1 hour, a daily report will be issued in addition to the 4x daily reports.

    Standard Report File Properties: Experience Events

    Property

    Data Type

    Length

    Primary Key

    Description

    Client ID

    string

    100

    Yes

    The unique identifier of the Client.

    Event Type

    string

    255

    Yes

    Identifies the main event type category.

    Event Subtype

    string

    255

    Yes

    Identifies the subtype of the event.

    Event Timestamp

    date

    Yes

    Contains the date and time of when the event occurred. The data is in ISO 8601 format.

    CCID

    string

    255

    Yes

    The unique identifier of the Customer.

    Secondary Account ID

    string

    255

    Yes

    This field can be used to tie the Customer back to another external system.

    Product Group ID

    string

    255

    No

    The current product group identifier of the Customer. An account is associated to one and only one product group at a time.

    Channel Address

    string

    100

    No

    Contains the channel address. The value and format will be different based on the channel_type value. The value is optional and may be set to null.

    sms
    11 digit mobile number


    Client Message Tag

    string

    255

    No

    An optional, Client created, tag that was provided during the initial messaging/onboarding request.

    Outcome

    string

    255

    No

    The outcome assigned to the feed message.

    Experience Type

    string

    255

    No

    The experience type assigned to the feed message.

    Experience Name

    string

    100

    No

    The name given to a collection of messages. An organizational name.

    Trigger Name

    string

    100

    No

    An optional friendly name associated with the experience trigger.

    Message Name

    string

    100

    No

    The name of the message that was set in the CXB.

    Action Label

    string

    100

    No

    The action label describing the action of the feed user. Also referred to as the text on an action element within a feed experience.

    Examples: "Call Customer Service" or "Provide Feedback"

    Action Value

    string

    255

    No

    The destination of an action paired with the Action Label. Example:

    Action Label: Call Customer Service

    Action Value: (800) 555 1234

    Is Resent Auth Link

    boolean

    2

    No

    Is this a new auth link to an existing message? 

    TRUE or FALSE.

    Error Type

    string

    100

    No

    Identifies the type of error that occurred. Valid values are:

    ErrorDescription
    ccid-not-foundThe CCID specified was not found.
    missing-fieldsThe same message was already sent within the duplicate suppression window.
    invalid-html-in-wire-messageThe experience may hav an invalid HTML tag in the message or SMS body.
    invalid-html-in-sms-message
    		The experience may hav an invalid HTML tag in the message or SMS body.
    throttle-customerMessage exceeds SMS send window threshold.
    duplicate-requestThe same message was already sent within the duplicate suppression window.
    trigger-not-foundThe trigger_id could not be found for the corresponding client_id.
    journey-archivedThe experience has been archived.
    customer-deactivatedThe customer specified has been deactivated.

    Error Description

    string

    255

    No

    The description of the result code or a detailed description including ids.

    Values include: 

    not_consented
    		duplicate
    no-channel-found-for-customer
    		deactivated
    sms_throttle
    		missing input parameters: [account_fieldname1]
    missing input parameters: [input_fieldname2]
    		Duplicate message suppression is active.
    No journey found for trigger_id [client_trigger_id/trigger_id].
    		Customer id [ccid] not found.
    Carrier has accepted the message for delivery.
    		Carrier Success.

    Launched By

    string

    100

    No

    The name of the person or system that triggered the experience to the customer. This value can be passed in at time of trigger OR system default values may be used.

    Journey ID

    string

    255

    No

    A unique Relay experience identifier.

    Trigger ID

    string

    255

    No

    The trigger id of the Relay experience the event is related to.

    Message ID

    string

    255

    No

    The unique, internal Relay feed message identifier.

    Notification ID

    string

    255

    No

    A unique Relay notification identifier.

    Event ID

    string

    255

    No

    This is a unique Relay identifier used for tracking.

    Custom Data

    string

    1000

    No

    If custom data is desired, this field will be added to include EXT fields.

    Guidance Document and Sample Report can be found here:

    Experience Events Report Guide
    185.19 KB

    Was this article helpful?
    What's Next
    ESC

    Eddy AI, facilitating knowledge discovery through conversational intelligence